Package org.odpi.openmetadata.frameworks.discovery.properties

Class PropertyBase

java.lang.Object

org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Annotation, DataField, DiscoveryAnalysisReport, DiscoveryEngineProperties, DiscoveryServiceProperties

public abstract class PropertyBase
extends Object
implements Serializable

This property header implements any common mechanisms that all property objects need.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static long	CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
PropertyBase()	Typical Constructor
PropertyBase(PropertyBase template)	Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;

Method Summary

Modifier and Type	Method	Description
ElementHeader	getElementHeader()	The element header is setup when an element is retrieved from the repository.
Map<String,Object>	getExtendedProperties()	Return the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
long	getHeaderVersion()	Return the version of this header.
String	getTypeName()	Return the name of the type of annotation - default is "Annotation".
void	setElementHeader(ElementHeader elementHeader)	The element header is setup when an element is retrieved from the repository.
void	setExtendedProperties(Map<String,Object> extendedProperties)	Set up the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.
void	setHeaderVersion(long headerVersion)	Return the version of this header.
void	setTypeName(String typeName)	Set up the name of the type of annotation - default is "Annotation".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CURRENT_AUDIT_HEADER_VERSION

public static final long CURRENT_AUDIT_HEADER_VERSION

See Also:

Constant Field Values

Constructor Detail

PropertyBase

public PropertyBase()

Typical Constructor

PropertyBase

public PropertyBase(PropertyBase template)

Copy/clone Constructor the resulting object will return true if tested with this.equals(template) as long as the template object is not null;

Parameters:

template - object being copied

Method Detail

getHeaderVersion

public long getHeaderVersion()

Return the version of this header. This is used by the OMAS to determine if it is back level and should not process events from a source that is more advanced because it does not have the ability to receive all of the header properties.

Returns:

long version number - the value is incremented each time a new non-informational field is added to the audit header.

setHeaderVersion

public void setHeaderVersion(long headerVersion)

Return the version of this header. This is used by the OMAS to determine if it is back level and should not process events from a source that is more advanced because it does not have the ability to receive all of the header properties.

Parameters:

headerVersion - long version number - the value is incremented each time a new non-informational field is added to the audit header.

getElementHeader

public ElementHeader getElementHeader()

The element header is setup when an element is retrieved from the repository. It contains the control information and classifications for the object. It does not need to be filled out for create and update requests.

Returns:

element header

setElementHeader

public void setElementHeader(ElementHeader elementHeader)

The element header is setup when an element is retrieved from the repository. It contains the control information and classifications for the object. It does not need to be filled out for create and update requests.

Parameters:

elementHeader - control header

getTypeName

public String getTypeName()

Return the name of the type of annotation - default is "Annotation".

Returns:

unique open metadata type name

setTypeName

public void setTypeName(String typeName)

Set up the name of the type of annotation - default is "Annotation".

Parameters:

typeName - unique open metadata type name

getExtendedProperties

public Map<String,Object> getExtendedProperties()

Return the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.

Returns:

property map

setExtendedProperties

public void setExtendedProperties(Map<String,Object> extendedProperties)

Set up the properties that have been defined for a subtype of this object that are not supported explicitly by this bean.

Parameters:

extendedProperties - property map