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.

  • Constructor Summary

    Constructors
    Constructor
    Description
    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

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

  • Constructor Details

    • 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.
      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