Class Location
- java.lang.Object
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.Location
-
- All Implemented Interfaces:
Serializable
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.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Stringdescriptionprotected StringdisplayName-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
additionalProperties, confidenceGovernanceClassification, confidentialityGovernanceClassification, criticalityGovernanceClassification, latestChange, latestChangeDetails, meanings, qualifiedName, retentionGovernanceClassification, searchKeywords, securityTags
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
classifications, extendedProperties, guid, type, url
-
Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object objectToCompare)Compare the values of the supplied object with those stored in the current object.StringgetDescription()Returns the stored description property for the location.StringgetDisplayName()Return the stored display name property for the location.inthashCode()Hash of propertiesvoidsetDescription(String description)Set up the stored description property for the location.voidsetDisplayName(String displayName)Set up the stored display name property for the location.StringtoString()Standard toString method.-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable
getAdditionalProperties, getConfidenceGovernanceClassification, getConfidentialityGovernanceClassification, getCriticalityGovernanceClassification, getLatestChange, getLatestChangeDetails, getMeanings, getQualifiedName, getRetentionGovernanceClassification, getSearchKeywords, getSecurityTags, setAdditionalProperties, setConfidenceGovernanceClassification, setConfidentialityGovernanceClassification, setCriticalityGovernanceClassification, setLatestChange, setLatestChangeDetails, setMeanings, setQualifiedName, setRetentionGovernanceClassification, setSearchKeywords, setSecurityTags
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader
getClassifications, getExtendedProperties, getGUID, getType, getURL, setClassifications, setExtendedProperties, setGUID, setType, setURL
-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.PropertyBase
getHeaderVersion, setHeaderVersion
-
-
-
-
Constructor Detail
-
Location
public Location()
Default constructor
-
Location
public Location(Location templateLocation)
Copy/clone constructor- Parameters:
templateLocation- template object to copy.
-
-
Method Detail
-
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:
toStringin classReferenceable- 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:
equalsin classReferenceable- Parameters:
objectToCompare- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()
Hash of properties- Overrides:
hashCodein classReferenceable- Returns:
- int
-
-