Package org.odpi.openmetadata.frameworks.openmetadata.search

Class AnchorOptions

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions
org.odpi.openmetadata.frameworks.openmetadata.search.MetadataSourceOptions
org.odpi.openmetadata.frameworks.openmetadata.search.AnchorOptions
Direct Known Subclasses:
ActionRequestBody, NewLinkedElementOptions
public class AnchorOptions extends MetadataSourceOptions
AnchorOptions provides a structure for the anchor properties when creating an element.

  • Constructor Details

    • AnchorOptions

      public AnchorOptions()
      Default constructor

    • AnchorOptions

      public AnchorOptions(AnchorOptions template)
      Copy/clone constructor
      Parameters:
      template - object to copy

    • AnchorOptions

      public AnchorOptions(MetadataSourceOptions template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getAnchorGUID

      public String getAnchorGUID()
      Return the unique identifier of the element that should be the anchor for the new element. It is set to null if no anchor, or the Anchors classification is included in the initial classifications.
      Returns:
      string guid

    • setAnchorGUID

      public void setAnchorGUID(String anchorGUID)
      Set up the unique identifier of the element that should be the anchor for the new element. Set to null if no anchor, or the new collection should be its own anchor.
      Parameters:
      anchorGUID - string guid

    • getIsOwnAnchor

      public boolean getIsOwnAnchor()
      Return whether this element should be classified as its own anchor or not. The default is false.
      Returns:
      boolean

    • setIsOwnAnchor

      public void setIsOwnAnchor(boolean ownAnchor)
      Set up whether this element should be classified as its own anchor or not. The default is false.
      Parameters:
      ownAnchor - boolean

    • getAnchorScopeGUID

      public String getAnchorScopeGUID()
      Return the unique identifier of the anchor's scope. If this is not supplied, the value set in the anchor entity's Anchors classification is used.
      Returns:
      string guid

    • setAnchorScopeGUID

      public void setAnchorScopeGUID(String anchorScopeGUID)
      Set up the unique identifier of the anchor's scope. If this is not supplied, the value set in the anchor entity's Anchors classification is used.
      Parameters:
      anchorScopeGUID - string guid

    • toString

      public String toString()
      JSON-style toString.
      Overrides:
      toString in class MetadataSourceOptions
      Returns:
      list of properties and their values.

    • equals

      public boolean equals(Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      Overrides:
      equals in class MetadataSourceOptions
      Parameters:
      objectToCompare - object to compare
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class MetadataSourceOptions
      Returns:
      int hash code