Package org.odpi.openmetadata.commonservices.generichandlers

Class ReferenceableBuilder

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

Direct Known Subclasses:

ActorProfileBuilder, AssetBuilder, CollectionBuilder, CommentBuilder, ConnectionBuilder, ConnectorTypeBuilder, ContributionRecordBuilder, DiscoveryAnalysisReportBuilder, ExternalReferenceBuilder, GlossaryBuilder, GlossaryCategoryBuilder, GlossaryTermBuilder, GovernanceActionBuilder, GovernanceActionTypeBuilder, GovernanceDefinitionBuilder, GovernanceDomainBuilder, GovernanceZoneBuilder, LocationBuilder, OperatingPlatformBuilder, PersonRoleBuilder, PortBuilder, ProjectBuilder, PropertyFacetBuilder, SchemaAttributeBuilder, SchemaTypeBuilder, SoftwareCapabilityBuilder, SoftwareServerCapabilityBuilder, SubjectAreaBuilder, UserIdentityBuilder, ValidValuesBuilder

public class ReferenceableBuilder
extends OpenMetadataAPIGenericBuilder

ReferenceableBuilder creates Open Metadata Repository Services (OMRS) objects based on the bean properties supplied in the constructor.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	qualifiedName

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

errorHandler, existingClassifications, extendedProperties, instanceStatus, newClassifications, repositoryHelper, serverName, serviceName, templateProperties, typeGUID, typeName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReferenceableBuilder(String qualifiedName, String typeId, String typeName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor for simple creates.
protected	ReferenceableBuilder(String typeId, String typeName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor for simple creates.
protected	ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeId, String typeName, Map<String,Object> extendedProperties, InstanceStatus instanceStatus, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor for templated entities.
protected	ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeId, String typeName, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor for updates.
protected	ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeId, String typeName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor for updates.
protected	ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor for updates.
protected	ReferenceableBuilder(String qualifiedName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor for simple creates.
protected	ReferenceableBuilder(OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor for simple creates.

Method Summary

Modifier and Type	Method	Description
InstanceProperties	getInstanceProperties(String methodName)	Return the supplied bean properties in an InstanceProperties object.
String	getQualifiedName()	Return the qualified name so the handler can check for uniqueness.
void	setMemento(String userId, Date archiveDate, String archiveUser, String archiveProcess, Map<String,String> archiveProperties, String methodName)	Set up the Memento classification.
protected void	setOwnershipClassification(String userId, String owner, String ownerTypeName, String ownerPropertyName, String methodName)	Set up the Ownership classification for this entity.
void	setSecurityTags(String userId, List<String> securityLabels, Map<String,Object> securityProperties, String methodName)	Set up the SecurityTags classification for this entity.
void	setTemplate(String userId, String name, String description, Map<String,String> additionalProperties, String methodName)	Set up the Template classification.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

getEntityClassificationProperties, getEntityClassifications, getExistingEntityClassificationHeader, getInstanceProperties, getInstanceStatus, getTypeGUID, getTypeName, setAnchors, setClassification, setEffectivityDates, setEffectivityDates, setLatestChange, setTemplateClassifications, updateInstanceProperties

Methods inherited from class java.lang.Object

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

Field Detail

qualifiedName

protected String qualifiedName

Constructor Detail

ReferenceableBuilder

protected ReferenceableBuilder(OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for simple creates.

Parameters:

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for simple creates.

Parameters:

qualifiedName - unique name

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String typeId,
                               String typeName,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for simple creates.

Parameters:

typeId - type GUID to use for the entity

typeName - type name to use for the entity

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               String typeId,
                               String typeName,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for simple creates.

Parameters:

qualifiedName - unique name

typeName - type name to use for the entity

typeId - type GUID to use for the entity

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for updates.

Parameters:

qualifiedName - unique name

additionalProperties - additional properties

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               String typeId,
                               String typeName,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for updates.

Parameters:

qualifiedName - unique name

additionalProperties - additional properties

typeName - type name to use for the entity

typeId - type GUID to use for the entity

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               String typeId,
                               String typeName,
                               Map<String,Object> extendedProperties,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for updates.

Parameters:

qualifiedName - unique name

additionalProperties - name value pairs for values that are not formally defined in the type system

typeName - type name to use for the entity

typeId - type GUID to use for the entity

extendedProperties - properties from the subtype.

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               String typeId,
                               String typeName,
                               Map<String,Object> extendedProperties,
                               InstanceStatus instanceStatus,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for templated entities.

Parameters:

qualifiedName - unique name

additionalProperties - name value pairs for values that are not formally defined in the type system

typeName - type name to use for the entity

typeId - type GUID to use for the entity

extendedProperties - properties from the subtype

instanceStatus - initial instance status for the entity

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Detail

setOwnershipClassification

protected void setOwnershipClassification(String userId,
                                          String owner,
                                          String ownerTypeName,
                                          String ownerPropertyName,
                                          String methodName)
                                   throws InvalidParameterException

Set up the Ownership classification for this entity. This method overrides an previously defined AssetOwnership classification for this entity.

Parameters:

userId - calling user

owner - name of the owner

ownerTypeName - type of element that owner comes from

ownerPropertyName - name of property used to identify owner

methodName - calling method

Throws:

InvalidParameterException - Ownership is not supported in the local repository, or any repository connected by an open metadata repository cohort

setTemplate

public void setTemplate(String userId,
                        String name,
                        String description,
                        Map<String,String> additionalProperties,
                        String methodName)
                 throws InvalidParameterException

Set up the Template classification.

Parameters:

userId - calling user

name - template name

description - template description

additionalProperties - additional properties about the template

methodName - calling method

Throws:

InvalidParameterException - Template classification not available in the repositories

setMemento

public void setMemento(String userId,
                       Date archiveDate,
                       String archiveUser,
                       String archiveProcess,
                       Map<String,String> archiveProperties,
                       String methodName)
                throws InvalidParameterException

Set up the Memento classification.

Parameters:

userId - calling user

archiveDate - timestamp that the archive either occurred or was detected

archiveUser - name of user responsible for performing the archive (or detecting it)

archiveProcess - process responsible for performing the archive (or detecting it)

archiveProperties - additional properties to locate the archived asset/artifact (if known)

methodName - calling method

Throws:

InvalidParameterException - Template classification not available in the repositories

setSecurityTags

public void setSecurityTags(String userId,
                            List<String> securityLabels,
                            Map<String,Object> securityProperties,
                            String methodName)
                     throws InvalidParameterException

Set up the SecurityTags classification for this entity. This method overrides an previously defined SecurityTags classification for this entity.

Parameters:

userId - calling user

securityLabels - list of security labels

securityProperties - map of name value pairs

methodName - calling method

Throws:

InvalidParameterException - security tags is not supported in the local repository, or any repository connected by an open metadata repository cohort

getQualifiedName

public String getQualifiedName()

Return the qualified name so the handler can check for uniqueness.

Returns:

string name

getInstanceProperties

public InstanceProperties getInstanceProperties(String methodName)
                                         throws InvalidParameterException

Return the supplied bean properties in an InstanceProperties object.

Overrides:

getInstanceProperties in class OpenMetadataAPIGenericBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

Throws:

InvalidParameterException - there is a problem with the properties