Package org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders

Class ReferenceableBuilder

java.lang.Object
org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder
org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.ReferenceableBuilder
Direct Known Subclasses:
SchemaTypeBuilder
public class ReferenceableBuilder extends RootBuilder
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 Map<String,String>
    additionalProperties
     
    protected Map<String,Object>
    extendedProperties
     
    protected org.odpi.openmetadata.frameworks.connectors.properties.beans.LatestChange
    latestChange
     
    protected String
    qualifiedName
     
    protected String
    typeId
     
    protected String
    typeName
     

    Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder

    classifications, errorHandler, repositoryHelper, serverName, serviceName

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ReferenceableBuilder(String qualifiedName, String typeName, String typeId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Constructor for simple creates.
    protected
    ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeName, String typeId, Map<String,Object> extendedProperties, String actionDescription, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Constructor for updates.
    protected
    ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeId, String typeName, Map<String,Object> extendedProperties, org.odpi.openmetadata.frameworks.connectors.properties.beans.LatestChange latestChange, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Constructor for updates.
    protected
    ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeName, String typeId, Map<String,Object> extendedProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Constructor for updates.
    protected
    ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeId, String typeName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Constructor for updates.
    protected
    ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Deprecated.
    protected
    ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Constructor for updates.
    protected
    ReferenceableBuilder(String qualifiedName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Constructor for simple creates.
     
    ReferenceableBuilder(org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable beanProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
    Constructor for classifications.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification>
    getEntityClassifications(String userId, String methodName)
    Return a list of entity classifications that can be stored in the metadata repository.
    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties
    getInstanceProperties(String methodName)
    Return the supplied bean properties in an InstanceProperties object.
    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties
    getNameInstanceProperties(String methodName)
    Return the supplied bean properties that represent a name in an InstanceProperties object for search.
    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties
    getQualifiedNameInstanceProperties(String methodName)
    Return the supplied bean properties that represent a name in an InstanceProperties object for search.
    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties
    getSearchInstanceProperties(String methodName)
    Return the supplied bean properties that represent a name in an InstanceProperties object.
    String
    getTypeId()
     
    String
    getTypeName()
     

    Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder

    getEntityClassifications, setClassifications

    Methods inherited from class java.lang.Object

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

  • Field Details

    • qualifiedName

      protected String qualifiedName

    • typeId

      protected String typeId

    • typeName

      protected String typeName

    • additionalProperties

      protected Map<String,String> additionalProperties

    • extendedProperties

      protected Map<String,Object> extendedProperties

    • latestChange

      protected org.odpi.openmetadata.frameworks.connectors.properties.beans.LatestChange latestChange

  • Constructor Details

    • ReferenceableBuilder

      protected ReferenceableBuilder(String qualifiedName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.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 qualifiedName, String typeName, String typeId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.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, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.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, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
      Constructor for updates.
      Parameters:
      qualifiedName - unique name
      additionalProperties - additional properties
      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

      @Deprecated protected ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
      Deprecated.
      Constructor for updates.
      Parameters:
      qualifiedName - unique name
      additionalProperties - additional properties
      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, org.odpi.openmetadata.frameworks.connectors.properties.beans.LatestChange latestChange, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)
      Constructor for updates.
      Parameters:
      qualifiedName - unique name
      additionalProperties - additional properties
      typeId - type GUID to use for the entity
      typeName - type name to use for the entity
      extendedProperties - properties from the subtype.
      latestChange - description of the last change to the asset.
      repositoryHelper - helper methods
      serviceName - name of this OMAS
      serverName - name of local server

    • ReferenceableBuilder

      protected ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeName, String typeId, Map<String,Object> extendedProperties, String actionDescription, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.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
      extendedProperties - properties from the subtype.
      actionDescription - description of the last change to the asset.
      repositoryHelper - helper methods
      serviceName - name of this OMAS
      serverName - name of local server

    • ReferenceableBuilder

      protected ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeName, String typeId, Map<String,Object> extendedProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.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
      extendedProperties - properties from the subtype.
      repositoryHelper - helper methods
      serviceName - name of this OMAS
      serverName - name of local server

    • ReferenceableBuilder

      public ReferenceableBuilder(org.odpi.openmetadata.frameworks.connectors.properties.beans.Referenceable beanProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Constructor for classifications.
      Parameters:
      beanProperties - properties and header
      repositoryHelper - helper methods
      serviceName - name of this OMAS
      serverName - name of local server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - bad properties in bean classifications

  • Method Details

    • getTypeId

      public String getTypeId()

    • getTypeName

      public String getTypeName()

    • getInstanceProperties

      public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getInstanceProperties(String methodName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Return the supplied bean properties in an InstanceProperties object.
      Overrides:
      getInstanceProperties in class RootBuilder
      Parameters:
      methodName - name of the calling method
      Returns:
      InstanceProperties object
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem with the properties

    • getNameInstanceProperties

      public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getNameInstanceProperties(String methodName)
      Return the supplied bean properties that represent a name in an InstanceProperties object for search.
      Parameters:
      methodName - name of the calling method
      Returns:
      InstanceProperties object

    • getQualifiedNameInstanceProperties

      public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getQualifiedNameInstanceProperties(String methodName)
      Return the supplied bean properties that represent a name in an InstanceProperties object for search.
      Parameters:
      methodName - name of the calling method
      Returns:
      InstanceProperties object

    • getSearchInstanceProperties

      public org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties getSearchInstanceProperties(String methodName)
      Return the supplied bean properties that represent a name in an InstanceProperties object.
      Parameters:
      methodName - name of the calling method
      Returns:
      InstanceProperties object

    • getEntityClassifications

      public List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> getEntityClassifications(String userId, String methodName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Return a list of entity classifications that can be stored in the metadata repository.
      Parameters:
      userId - calling user
      methodName - calling method
      Returns:
      list of entity classification objects
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the properties of the classification are flawed