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

Class Asset

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

All Implemented Interfaces:

Serializable

public class Asset
extends Referenceable

Asset 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)
• zoneMembership - name of the person or organization that owns the asset. (Sourced from attribute zoneMembership within Asset - model 0010)
• classifications - list of classifications assigned to the asset
• assetProperties - list of properties assigned to the asset from the Asset subclasses
• additionalProperties - list of properties assigned to the asset as additional properties

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	assetProperties
protected String	description
protected String	displayName
protected String	owner
protected String	shortDescription
protected List<String>	zoneMembership

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

additionalProperties, qualifiedName

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

classifications, guid, type, url

Constructor Summary

Constructors

Constructor and Description
Asset() Default constructor
Asset(Asset templateAsset) 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.
Map<String,Object>	getAssetProperties() Return a copy of the asset properties.
String	getDescription() Returns the stored description property for the asset.
String	getDisplayName() Returns the stored display name property for the asset.
String	getOwner() Returns the name of the owner for this asset.
String	getShortDescription() Returns the short description of the asset from relationship with Connection.
List<String>	getZoneMembership() Return the names of the zones that this asset is a member of.
void	setAssetProperties(Map<String,Object> assetProperties) Set up asset properties.
void	setDescription(String description) Set up the stored description property associated with the asset.
void	setDisplayName(String displayName) Set up the stored display name property for the asset.
void	setOwner(String owner) Set up the name of the owner for this asset.
void	setShortDescription(String shortDescription) Set up the short description of the asset from relationship with Connection.
void	setZoneMembership(List<String> zoneMembership) Set up the names of the zones that this asset is a member of.
String	toString() Standard toString method.

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

getAdditionalProperties, getQualifiedName, setAdditionalProperties, setQualifiedName

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

getClassifications, getGUID, getType, getURL, hashCode, setClassifications, setGUID, setType, setURL

Methods inherited from class java.lang.Object

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

Field Detail

displayName

protected String displayName

shortDescription

protected String shortDescription

description

protected String description

owner

protected String owner

zoneMembership

protected List<String> zoneMembership

assetProperties

protected Map<String,Object> assetProperties

Constructor Detail

Asset

public Asset()

Default constructor

Asset

public Asset(Asset templateAsset)

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

Parameters:

templateAsset - template values for asset summary

Method Detail

getDisplayName

public String getDisplayName()

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

Returns:

String name

setDisplayName

public void setDisplayName(String displayName)

Set up the stored display name property for the asset.

Parameters:

displayName - String name

getShortDescription

public String getShortDescription()

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

Returns:

shortDescription String

setShortDescription

public void setShortDescription(String shortDescription)

Set up the short description of the asset from relationship with Connection.

Parameters:

shortDescription - String text

getDescription

public String getDescription()

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

Returns:

description String text

setDescription

public void setDescription(String description)

Set up the stored description property associated with the asset.

Parameters:

description - String text

getOwner

public String getOwner()

Returns the name of the owner for this asset.

Returns:

owner String

setOwner

public void setOwner(String owner)

Set up the name of the owner for this asset.

Parameters:

owner - String name

getZoneMembership

public List<String> getZoneMembership()

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

Returns:

list of zone names

setZoneMembership

public void setZoneMembership(List<String> zoneMembership)

Set up the names of the zones that this asset is a member of.

Parameters:

zoneMembership - list of zone names

setAssetProperties

public void setAssetProperties(Map<String,Object> assetProperties)

Set up asset properties.

Parameters:

assetProperties - asset properties map

getAssetProperties

public Map<String,Object> getAssetProperties()

Return a copy of the asset properties. Null means no asset properties are available.

Returns:

asset property map

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