org.odpi.openmetadata.frameworks.connectors.properties.beans

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 and Description
protected String	description
protected String	displayName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

additionalProperties, meanings, qualifiedName

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementHeader

classifications, extendedProperties, guid, type, url

Constructor Summary

Constructors

Constructor and Description
Location() Default constructor
Location(Location templateLocation) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
String	getDescription() Returns the stored description property for the location.
String	getDisplayName() Return the stored display name property for the location.
void	setDescription(String description) Set up the stored description property for the location.
void	setDisplayName(String displayName) Set up the stored display name property for the location.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable

getAdditionalProperties, getMeanings, getQualifiedName, hashCode, setAdditionalProperties, setMeanings, setQualifiedName

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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

displayName

protected String displayName

description

protected String description

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:

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