org.odpi.openmetadata.frameworks.connectors.properties

Class AssetLocation

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

org.odpi.openmetadata.frameworks.connectors.properties.AssetLocation

All Implemented Interfaces:

Serializable

public class AssetLocation
extends AssetReferenceable

AssetLocation 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 Location	locationBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

referenceableBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Constructor and Description
AssetLocation(AssetDescriptor parentAsset, AssetLocation templateLocation) Copy/clone constructor
AssetLocation(AssetDescriptor parentAsset, Location locationBean) Bean constructor and parent asset
AssetLocation(Location locationBean) Bean 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() Returns the stored display name property for the location.
protected Location	getLocationBean() Return the bean with all of the properties in it.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetReferenceable

getAdditionalProperties, getMeanings, getQualifiedName, getReferenceableBean, getSecurityTags, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getExtendedProperties, getGUID, getType, getURL, hashCode, setBean

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

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

Field Detail

locationBean

protected Location locationBean

Constructor Detail

AssetLocation

public AssetLocation(Location locationBean)

Bean constructor

Parameters:

locationBean - bean containing all of the properties

AssetLocation

public AssetLocation(AssetDescriptor parentAsset,
                     Location locationBean)

Bean constructor and parent asset

Parameters:

parentAsset - descriptor for parent asset

locationBean - bean containing all of the properties

AssetLocation

public AssetLocation(AssetDescriptor parentAsset,
                     AssetLocation templateLocation)

Copy/clone constructor

Parameters:

parentAsset - description of the asset that this location is attached to.

templateLocation - template object to copy.

Method Detail

getLocationBean

protected Location getLocationBean()

Return the bean with all of the properties in it.

Returns:

location bean

getDisplayName

public String getDisplayName()

Returns the stored display name property for the location. If no display name is available then null is returned.

Returns:

displayName

getDescription

public String getDescription()

Returns the stored description property for the location. If no description is provided then null is returned.

Returns:

description

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetReferenceable

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 AssetReferenceable

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison