org.odpi.openmetadata.frameworks.connectors.properties

Class AssetRelatedAsset

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

All Implemented Interfaces:

Serializable

public class AssetRelatedAsset
extends AssetReferenceable

AssetRelatedAsset describes assets that are related to this asset. For example, if the asset is a data store, the related assets could be its supported data sets.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Asset	assetBean
protected RelatedAssetProperties	relatedAssetProperties
protected String	relationshipAttributeName
protected String	relationshipTypeName

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
AssetRelatedAsset(AssetDescriptor parentAsset, AssetRelatedAsset templateRelatedAsset) Copy/clone constructor
AssetRelatedAsset(AssetDescriptor parentAsset, Asset assetBean, String relationshipTypeName, String relationshipAttributeName, RelatedAssetProperties relatedAssetProperties) Bean constructor with parent asset
AssetRelatedAsset(Asset assetBean, String relationshipTypeName, String relationshipAttributeName, RelatedAssetProperties relatedAssetProperties) 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.
protected Asset	getAssetBean() Return the bean with basic information about the asset.
String	getDescription() Returns the stored description property for the related asset.
String	getDisplayName() Returns the stored display name property for the related asset.
String	getOwner() Returns the details of the owner for this related asset.
RelatedAssetProperties	getRelatedAssetProperties() Return the detailed properties for a related asset.
String	getRelationshipAttributeName() Return the attribute name for the related asset.
String	getRelationshipTypeName() Return the name of the relationship between the anchor asset and th related asset
String	getShortDescription() Returns the summary description property for the related asset.
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

assetBean

protected Asset assetBean

relationshipTypeName

protected String relationshipTypeName

relationshipAttributeName

protected String relationshipAttributeName

relatedAssetProperties

protected RelatedAssetProperties relatedAssetProperties

Constructor Detail

AssetRelatedAsset

public AssetRelatedAsset(Asset assetBean,
                         String relationshipTypeName,
                         String relationshipAttributeName,
                         RelatedAssetProperties relatedAssetProperties)

Bean constructor

Parameters:

assetBean - bean containing basic properties

relationshipTypeName - name of the relationship between the anchor asset and the related asset

relationshipAttributeName - name of the end of the relationship between the anchor asset and the related asset

relatedAssetProperties - client for retrieving properties from the server

AssetRelatedAsset

public AssetRelatedAsset(AssetDescriptor parentAsset,
                         Asset assetBean,
                         String relationshipTypeName,
                         String relationshipAttributeName,
                         RelatedAssetProperties relatedAssetProperties)

Bean constructor with parent asset

Parameters:

parentAsset - descriptor for parent asset

assetBean - bean containing basic properties

relationshipTypeName - name of the relationship between the anchor asset and th related asset

relationshipAttributeName - name of the end of the relationship between the anchor asset and the related asset

relatedAssetProperties - client for retrieving properties from the server

AssetRelatedAsset

public AssetRelatedAsset(AssetDescriptor parentAsset,
                         AssetRelatedAsset templateRelatedAsset)

Copy/clone constructor

Parameters:

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

templateRelatedAsset - template object to copy.

Method Detail

getAssetBean

protected Asset getAssetBean()

Return the bean with basic information about the asset.

Returns:

assetBean

getDisplayName

public String getDisplayName()

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

Returns:

displayName

getShortDescription

public String getShortDescription()

Returns the summary description property for the related asset. If no description is provided then null is returned.

Returns:

summary description

getDescription

public String getDescription()

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

Returns:

description

getOwner

public String getOwner()

Returns the details of the owner for this related asset.

Returns:

String owner

getRelationshipTypeName

public String getRelationshipTypeName()

Return the name of the relationship between the anchor asset and th related asset

Returns:

relationship type name

getRelationshipAttributeName

public String getRelationshipAttributeName()

Return the attribute name for the related asset.

Returns:

string name

getRelatedAssetProperties

public RelatedAssetProperties getRelatedAssetProperties()
                                                 throws PropertyServerException,
                                                        UserNotAuthorizedException

Return the detailed properties for a related asset.

Returns:

a refreshed version of the RelatedAssetProperties

Throws:

UserNotAuthorizedException - the calling user does not have access to the asset.

PropertyServerException - problems communicating with the property (metadata) server

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