org.odpi.openmetadata.frameworks.connectors.properties

Class ConnectedAssetProperties

java.lang.Object

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

org.odpi.openmetadata.frameworks.connectors.properties.ConnectedAssetProperties

All Implemented Interfaces:

Serializable

public abstract class ConnectedAssetProperties
extends AssetPropertyElementBase

ConnectedAssetProperties is associated with a Connector. Connectors provide access to assets. ConnectedAssetProperties returns properties (metadata) about the connector's asset. It is a generic interface for all types of open metadata assets. However, it assumes the asset's metadata model inherits from Asset (see model 0010 in Area 0). The ConnectedAssetProperties returns metadata about the asset at three levels of detail:

• assetSummary used for displaying details of the asset in summary lists or hover text
• assetDetail used to display all of the information known about the asset with summaries of the relationships to other metadata entities
• assetUniverse used to define the broader context for the asset

ConnectedAssetProperties is a base class for the connector's metadata API that returns null, for the asset's properties. Metadata repository implementations extend this class to add their implementation of the refresh() method that calls to the metadata repository to populate the metadata properties.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AssetUniverse	assetProperties

Constructor Summary

Constructors

Constructor and Description
ConnectedAssetProperties() Typical constructor.
ConnectedAssetProperties(ConnectedAssetProperties templateProperties) Copy/clone constructor.

Method Summary

Modifier and Type	Method and Description
AssetDetail	getAssetDetail() Returns detailed information about the asset organized in the assetDetail structure.
AssetSummary	getAssetSummary() Returns the summary information organized in the assetSummary structure.
AssetUniverse	getAssetUniverse() Returns all of the detail of the asset and information connected to it in organized in the assetUniverse structure.
abstract void	refresh() Request the values in the ConnectedAssetProperties are refreshed with the current values from the metadata repository.
String	toString() Standard toString method.

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

equals, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

assetProperties

protected AssetUniverse assetProperties

Constructor Detail

ConnectedAssetProperties

public ConnectedAssetProperties()

Typical constructor.

ConnectedAssetProperties

public ConnectedAssetProperties(ConnectedAssetProperties templateProperties)

Copy/clone constructor.

Parameters:

templateProperties - template to copy.

Method Detail

getAssetSummary

public AssetSummary getAssetSummary()

Returns the summary information organized in the assetSummary structure.

Returns:

AssetSummary summary object

getAssetDetail

public AssetDetail getAssetDetail()

Returns detailed information about the asset organized in the assetDetail structure.

Returns:

AssetDetail detail object

getAssetUniverse

public AssetUniverse getAssetUniverse()

Returns all of the detail of the asset and information connected to it in organized in the assetUniverse structure.

Returns:

AssetUniverse universe object

refresh

public abstract void refresh()
                      throws PropertyServerException,
                             UserNotAuthorizedException

Request the values in the ConnectedAssetProperties are refreshed with the current values from the metadata repository.

Throws:

PropertyServerException - there is a problem connecting to the server to retrieve metadata.

UserNotAuthorizedException - the userId associated with the connector is not authorized to access the asset properties.

toString

public String toString()

Standard toString method.

Overrides:

toString in class AssetPropertyElementBase

Returns:

print out of variables in a JSON-style