org.odpi.openmetadata.frameworks.connectors.properties

Class AssetSummary

java.lang.Object

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

org.odpi.openmetadata.frameworks.connectors.properties.AssetDescriptor

org.odpi.openmetadata.frameworks.connectors.properties.AssetSummary

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AssetDetail

public class AssetSummary
extends AssetDescriptor

AssetSummary holds asset properties that are used for displaying details of an asset in summary lists or hover text. It includes the following properties:

• type - metadata type information for the asset
• guid - globally unique identifier for the asset
• url - external link for the asset
• qualifiedName - The official (unique) name for the asset. This is often defined by the IT systems management organization and should be used (when available) on audit logs and error messages. (qualifiedName from Referenceable - model 0010)
• displayName - A consumable name for the endpoint. Often a shortened form of the assetQualifiedName for use on user interfaces and messages. The assetDisplayName should be only be used for audit logs and error messages if the assetQualifiedName is not set. (Sourced from attribute name within Asset - model 0010)
• shortDescription - short description about the asset. (Sourced from assetSummary within ConnectionsToAsset - model 0205)
• description - full description of the asset. (Sourced from attribute description within Asset - model 0010)
• owner - name of the person or organization that owns the asset. (Sourced from attribute owner within Asset - model 0010)
• classifications - list of classifications assigned to the asset

See Also:

Serialized Form

Field Summary

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

assetBean

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AssetSummary() Default constructor only for subclasses
	AssetSummary(Asset assetBean) Bean constructor - initializes AssetSummary using a bean returned by the REST interface.
	AssetSummary(AssetSummary templateAssetSummary) 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.
AdditionalProperties	getAdditionalProperties() Return the set of additional properties.
List<AssetClassification>	getAssetClassifications() Return the list of classifications associated with the asset.
AdditionalProperties	getAssetProperties() Return the set of properties that are specific to the particular type of asset.
String	getDescription() Returns the stored description property for the asset.
String	getDisplayName() Returns the stored display name property for the asset.
String	getGUID() Return the unique id for the properties object.
String	getOwner() Returns the name of the owner for this asset.
String	getQualifiedName() Returns the stored qualified name property for the asset.
String	getShortDescription() Returns the short description of the asset from relationship with Connection.
AssetElementType	getType() Return the element type properties for this asset.
String	getURL() Returns the URL to access the properties object in the metadata repository.
List<String>	getZoneMembership() Return the names of the zones that this asset is a member of.
int	hashCode() Create a hash code for this element type.
String	toString() Standard toString method.

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

getAssetBean, getAssetName, getAssetTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetSummary

protected AssetSummary()

Default constructor only for subclasses

AssetSummary

public AssetSummary(Asset assetBean)

Bean constructor - initializes AssetSummary using a bean returned by the REST interface.

Parameters:

assetBean - asset properties bean

AssetSummary

public AssetSummary(AssetSummary templateAssetSummary)

Copy/clone constructor. Note, this is a deep copy

Parameters:

templateAssetSummary - template values for asset summary

Method Detail

getType

public AssetElementType getType()

Return the element type properties for this asset. These values are set up by the metadata repository and define details to the metadata entity used to represent this element.

Returns:

AssetElementType type information.

getGUID

public String getGUID()

Return the unique id for the properties object. Null means no guid is assigned.

Returns:

String unique id

getURL

public String getURL()

Returns the URL to access the properties object in the metadata repository. If no url is available then null is returned.

Returns:

String URL

getQualifiedName

public String getQualifiedName()

Returns the stored qualified name property for the asset. If no qualified name is provided then null is returned.

Returns:

qualifiedName

getDisplayName

public String getDisplayName()

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

Returns:

displayName

getShortDescription

public String getShortDescription()

Returns the short description of the asset from relationship with Connection.

Returns:

shortDescription String

getDescription

public String getDescription()

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

Returns:

description String

getOwner

public String getOwner()

Returns the name of the owner for this asset.

Returns:

owner String

getZoneMembership

public List<String> getZoneMembership()

Return the names of the zones that this asset is a member of.

Returns:

list of zone names

getAssetClassifications

public List<AssetClassification> getAssetClassifications()

Return the list of classifications associated with the asset.

Returns:

list of classifications

getAssetProperties

public AdditionalProperties getAssetProperties()

Return the set of properties that are specific to the particular type of asset. The caller is given their own copy of the property object. The properties are named entityName.attributeName. The values are all strings.

Returns:

AdditionalProperties asset properties using the name of attributes from the model.

getAdditionalProperties

public AdditionalProperties getAdditionalProperties()

Return the set of additional properties.

Returns:

AdditionalProperties object.

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetPropertyElementBase

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 AssetPropertyElementBase

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class AssetPropertyElementBase

Returns:

int hash code