Package org.odpi.openmetadata.frameworks.integration.bitol.mapping

Class BitolMappingResult

java.lang.Object

org.odpi.openmetadata.frameworks.integration.bitol.mapping.BitolMappingResult

public class BitolMappingResult
extends Object

BitolMappingResult describes the outcome of cataloguing a Bitol document into open metadata: the unique identifier of the element that represents the document, whether it was created, updated or removed, and any parts of the document that could not be fully represented (for example a team member whose user identity is not known to Egeria, or a data contract that is referenced but not yet catalogued).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BitolMappingResult.Action	The action taken on the element that represents the document.

Constructor Summary

Constructors

Constructor	Description
BitolMappingResult(String kind, String documentId, String documentVersion, String qualifiedName)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addWarning(String warning)	Record a part of the document that could not be fully represented.
BitolMappingResult.Action	getAction()	Return the action taken.
String	getDocumentId()	Return the identifier from the document.
String	getDocumentVersion()	Return the version from the document.
String	getElementGUID()	Return the unique identifier of the element that represents the document.
String	getKind()	Return the kind of document.
String	getQualifiedName()	Return the qualified name used for the element that represents the document.
List<String>	getWarnings()	Return the parts of the document that could not be fully represented.
void	setAction(BitolMappingResult.Action action)	Set up the action taken.
void	setElementGUID(String elementGUID)	Set up the unique identifier of the element that represents the document.
String	toString()	Standard toString method.

Methods inherited from class java.lang.Object

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

Constructor Details

BitolMappingResult

public BitolMappingResult(String kind,
 String documentId,
 String documentVersion,
 String qualifiedName)

Constructor.

Parameters:

kind - kind of document

documentId - identifier from the document

documentVersion - version from the document

qualifiedName - qualified name used for the element that represents the document

Method Details

getKind

public String getKind()

Return the kind of document.

Returns:

DataContract or DataProduct

getDocumentId

public String getDocumentId()

Return the identifier from the document.

Returns:

string

getDocumentVersion

public String getDocumentVersion()

Return the version from the document.

Returns:

string

getQualifiedName

public String getQualifiedName()

Return the qualified name used for the element that represents the document.

Returns:

string

getElementGUID

public String getElementGUID()

Return the unique identifier of the element that represents the document.

Returns:

guid or null if the document was skipped

setElementGUID

public void setElementGUID(String elementGUID)

Set up the unique identifier of the element that represents the document.

Parameters:

elementGUID - guid

getAction

public BitolMappingResult.Action getAction()

Return the action taken.

Returns:

enum

setAction

public void setAction(BitolMappingResult.Action action)

Set up the action taken.

Parameters:

action - enum

getWarnings

public List<String> getWarnings()

Return the parts of the document that could not be fully represented.

Returns:

list of messages (empty if none)

addWarning

public void addWarning(String warning)

Record a part of the document that could not be fully represented.

Parameters:

warning - message

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

print out of variables in a JSON-style