org.odpi.openmetadata.accessservices.datamanager.properties

Class ArchiveProperties

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.properties.ArchiveProperties

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ArchiveRequestBody

public class ArchiveProperties
extends Object
implements Serializable

ArchiveProperties defined the properties that are stored when a data source is archived or deleted. This allows the Asset to remain in the metadata repository after the real-world artifact has gone. This is important to prevent lineage graphs from becoming fragmented.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ArchiveProperties() Default constructor
ArchiveProperties(ArchiveProperties template) Copy/clone constructor for the template properties.

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.
Date	getArchiveDate() Returns the date when the data source was archived (or discovered missing).
String	getArchiveProcess() Returns the name of the process that either performed the archive or detected the missing data source.
Map<String,String>	getArchiveProperties() Return the properties that characterize where the data source was archived to.
int	hashCode() Return has code based on properties.
void	setArchiveDate(Date archiveDate) Set up the date when the data source was archived (or discovered missing).
void	setArchiveProcess(String archiveProcess) Set up the name of the process that either performed the archive or detected the missing data source.
void	setArchiveProperties(Map<String,String> archiveProperties) Set up the properties that characterize where the data source was archived to.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveProperties

public ArchiveProperties()

Default constructor

ArchiveProperties

public ArchiveProperties(ArchiveProperties template)

Copy/clone constructor for the template properties.

Parameters:

template - template object to copy.

Method Detail

getArchiveDate

public Date getArchiveDate()

Returns the date when the data source was archived (or discovered missing). Null means "now".

Returns:

date of archive

setArchiveDate

public void setArchiveDate(Date archiveDate)

Set up the date when the data source was archived (or discovered missing). Null means "now".

Parameters:

archiveDate - date of archive

getArchiveProcess

public String getArchiveProcess()

Returns the name of the process that either performed the archive or detected the missing data source.

Returns:

String name

setArchiveProcess

public void setArchiveProcess(String archiveProcess)

Set up the name of the process that either performed the archive or detected the missing data source.

Parameters:

archiveProcess - String name

getArchiveProperties

public Map<String,String> getArchiveProperties()

Return the properties that characterize where the data source was archived to.

Returns:

map of name value pairs, all strings

setArchiveProperties

public void setArchiveProperties(Map<String,String> archiveProperties)

Set up the properties that characterize where the data source was archived to.

Parameters:

archiveProperties - map of name value pairs, all strings

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

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 Object

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return has code based on properties.

Overrides:

hashCode in class Object

Returns:

int