public class Location extends Referenceable
Location describes where the asset is located. The model allows a very flexible definition of location that can be set up at different levels of granularity.
  • Field Details

    • identifier

      protected String identifier
    • displayName

      protected String displayName
    • description

      protected String description
  • Constructor Details

    • Location

      public Location()
      Default constructor
    • Location

      public Location(Location templateLocation)
      Copy/clone constructor
      Parameters:
      templateLocation - template object to copy.
  • Method Details

    • getIdentifier

      public String getIdentifier()
      Return the unique identifier of the location.
      Returns:
      string
    • setIdentifier

      public void setIdentifier(String identifier)
      Set up the unique identifier of the location.
      Parameters:
      identifier - string
    • getDisplayName

      public String getDisplayName()
      Return the stored display name property for the location. If no display name is available then null is returned.
      Returns:
      String location name
    • setDisplayName

      public void setDisplayName(String displayName)
      Set up the stored display name property for the location.
      Parameters:
      displayName - String location name
    • getDescription

      public String getDescription()
      Returns the stored description property for the location. If no description is provided then null is returned.
      Returns:
      location description
    • setDescription

      public void setDescription(String description)
      Set up the stored description property for the location.
      Parameters:
      description - location description
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Referenceable
      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 Referenceable
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison
    • hashCode

      public int hashCode()
      Hash of properties
      Overrides:
      hashCode in class Referenceable
      Returns:
      int