org.odpi.openmetadata.frameworks.connectors.properties

Class AssetExternalReference

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.AssetExternalReference

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetRelatedMediaReference

public class AssetExternalReference
extends AssetReferenceable

ExternalReference stores information about an link to an external resource that is relevant to this asset.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ExternalReference	externalReferenceBean

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
AssetExternalReference(AssetDescriptor parentAsset, AssetExternalReference templateExternalReference) Copy/clone constructor.
AssetExternalReference(AssetDescriptor parentAsset, ExternalReference externalReferenceBean) Bean constructor with parent asset
AssetExternalReference(ExternalReference externalReferenceBean) 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	getDisplayName() Return the display name of this external reference.
protected ExternalReference	getExternalReferenceBean() Return the bean - used in the cloning process.
String	getLinkDescription() Return the description of the reference (with respect to this asset).
String	getOrganization() Return the name of the organization that owns the resource that this external reference represents.
String	getReferenceId() Return the identifier given to this reference (with respect to this asset).
String	getResourceDescription() Return the description of the resource that this external reference represents.
String	getURI() Return the URI used to retrieve the resource that this external reference represents.
String	getVersion() Return the version of the resource that this external reference represents.
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

externalReferenceBean

protected ExternalReference externalReferenceBean

Constructor Detail

AssetExternalReference

public AssetExternalReference(ExternalReference externalReferenceBean)

Bean constructor

Parameters:

externalReferenceBean - bean with all of the properties in it

AssetExternalReference

public AssetExternalReference(AssetDescriptor parentAsset,
                              ExternalReference externalReferenceBean)

Bean constructor with parent asset

Parameters:

parentAsset - descriptor for parent asset

externalReferenceBean - bean with all of the properties in it

AssetExternalReference

public AssetExternalReference(AssetDescriptor parentAsset,
                              AssetExternalReference templateExternalReference)

Copy/clone constructor.

Parameters:

parentAsset - descriptor for parent asset

templateExternalReference - element to copy

Method Detail

getExternalReferenceBean

protected ExternalReference getExternalReferenceBean()

Return the bean - used in the cloning process.

Returns:

bean with all of the properties in

getReferenceId

public String getReferenceId()

Return the identifier given to this reference (with respect to this asset).

Returns:

String referenceId

getLinkDescription

public String getLinkDescription()

Return the description of the reference (with respect to this asset).

Returns:

String link description.

getDisplayName

public String getDisplayName()

Return the display name of this external reference.

Returns:

String display name.

getURI

public String getURI()

Return the URI used to retrieve the resource that this external reference represents.

Returns:

String URI

getResourceDescription

public String getResourceDescription()

Return the description of the resource that this external reference represents.

Returns:

String resource description

getVersion

public String getVersion()

Return the version of the resource that this external reference represents.

Returns:

String version

getOrganization

public String getOrganization()

Return the name of the organization that owns the resource that this external reference represents.

Returns:

String organization name

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