Package org.odpi.openmetadata.frameworks.openmetadata.properties.locations

Class LocationProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.locations.LocationProperties
public class LocationProperties extends ReferenceableProperties
LocationProperties is a class for representing a generic location.

  • Constructor Details

    • LocationProperties

      public LocationProperties()
      Default constructor

    • LocationProperties

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

  • Method Details

    • getIdentifier

      public String getIdentifier()
      Return the code value or symbol used to identify the location - typically unique.
      Returns:
      string identifier

    • setIdentifier

      public void setIdentifier(String identifier)
      Set up the code value or symbol used to identify the location - typically unique.
      Parameters:
      identifier - string identifier

    • getDisplayName

      public String getDisplayName()
      Return a human memorable name for the location.
      Returns:
      string name

    • setDisplayName

      public void setDisplayName(String displayName)
      Set up a human memorable name for the location.
      Parameters:
      displayName - string name

    • getDescription

      public String getDescription()
      Return the description of the location.
      Returns:
      string text

    • setDescription

      public void setDescription(String description)
      Set up the description of the location.
      Parameters:
      description - string text

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class ReferenceableProperties
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class ReferenceableProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class ReferenceableProperties
      Returns:
      int