Class SchemaManagerClient

  • All Implemented Interfaces:
    SchemaManagerInterface
    Direct Known Subclasses:
    APIManagerClient, DisplayApplicationClient, EventBrokerClient, FilesAndFoldersClient

    public abstract class SchemaManagerClient
    extends java.lang.Object
    implements SchemaManagerInterface
    SchemaManagerClient defines the common methods for managing SchemaTypes and SchemaAttributes. It is incorporated in the EventBrokerClient and the APIManagerClient. SchemaAttributes describe the data fields of the schema. If a schema attribute's type is simple (that is primitive, literal, enum or external, its details are passed with the schema attribute. Complex schema types (such as Maps, Choices) are constructed first and then their identifiers are attached to the schema attribute. SchemaTypes are used when creating complex schema structures that involve maps, choice and links to externally defined schemas that are, for example, part of a standard.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearCalculatedValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaElementGUID)
      Remove the calculated value designation from the schema element.
      void clearQueryTargetRelationship​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String derivedElementGUID, java.lang.String queryTargetGUID)
      Remove the query target relationship between two schema elements.
      void clearSchemaTypes​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaAttributeGUID)
      Remove the linked schema types from a schema attribute.
      java.lang.String createEnumSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, EnumSchemaTypeProperties schemaTypeProperties, java.lang.String validValuesSetGUID)
      Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
      java.lang.String createLiteralSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, LiteralSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type that has a fixed value.
      java.lang.String createMapSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, MapSchemaTypeProperties schemaTypeProperties, java.lang.String mapFromSchemaTypeGUID, java.lang.String mapToSchemaTypeGUID)
      Create a new metadata element to represent a schema type.
      java.lang.String createPrimitiveSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, PrimitiveSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a primitive schema type such as a string, integer or character.
      java.lang.String createSchemaAttribute​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaElementGUID, SchemaAttributeProperties schemaAttributeProperties)
      Create a new metadata element to represent a schema attribute.
      java.lang.String createSchemaAttributeFromTemplate​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaElementGUID, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
      java.lang.String createSchemaTypeChoice​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, SchemaTypeChoiceProperties schemaTypeProperties, java.util.List<java.lang.String> schemaTypeOptionGUIDs)
      Create a new metadata element to represent a list of possible schema types that can be used for the attached schema attribute.
      java.lang.String createSchemaTypeFromTemplate​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a schema type using an existing metadata element as a template.
      java.lang.String createStructSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, StructSchemaTypeProperties schemaTypeProperties)
      Create a new metadata element to represent a schema type.
      java.util.List<SchemaAttributeElement> findSchemaAttributes​(java.lang.String userId, java.lang.String searchString, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema attribute metadata elements that contain the search string.
      java.util.List<SchemaTypeElement> findSchemaType​(java.lang.String userId, java.lang.String typeName, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of schema type metadata elements that contain the search string.
      java.util.List<ValidValueSetElement> findValidValueSet​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of valid value set metadata elements that contain the search string.
      java.util.List<SchemaAttributeElement> getNestedAttributes​(java.lang.String userId, java.lang.String parentSchemaElementGUID, int startFrom, int pageSize)
      Retrieve the list of schema attributes associated with a StructSchemaType or nested underneath a schema attribute.
      SchemaAttributeElement getSchemaAttributeByGUID​(java.lang.String userId, java.lang.String schemaAttributeGUID)
      Retrieve the schema attribute metadata element with the supplied unique identifier.
      java.util.List<SchemaAttributeElement> getSchemaAttributesByName​(java.lang.String userId, java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema attribute metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeByGUID​(java.lang.String userId, java.lang.String schemaTypeGUID)
      Retrieve the schema type metadata element with the supplied unique identifier.
      java.util.List<SchemaTypeElement> getSchemaTypeByName​(java.lang.String userId, java.lang.String name, java.lang.String typeName, int startFrom, int pageSize)
      Retrieve the list of schema type metadata elements with a matching qualified or display name.
      SchemaTypeElement getSchemaTypeForElement​(java.lang.String userId, java.lang.String parentElementGUID, java.lang.String parentElementTypeName)
      Return the schema type associated with a specific open metadata element (data asset, process or port).
      ElementStub getSchemaTypeParent​(java.lang.String userId, java.lang.String schemaTypeGUID)
      Retrieve the header of the metadata element connected to a schema type.
      java.util.List<ValidValueSetElement> getValidValueSetByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of valid value set metadata elements with a matching qualified or display name.
      void removeSchemaAttribute​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaAttributeGUID)
      Remove the metadata element representing a schema attribute.
      void removeSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaTypeGUID)
      Remove the metadata element representing a schema type.
      void setupCalculatedValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaElementGUID, java.lang.String formula)
      Classify the schema element to indicate that it describes a calculated value.
      void setupQueryTargetRelationship​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String derivedElementGUID, java.lang.String queryTargetGUID, DerivedSchemaTypeQueryTargetProperties queryTargetProperties)
      Link two schema elements together to show a query target relationship.
      void setupSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String relationshipTypeName, java.lang.String schemaAttributeGUID, java.lang.String schemaTypeGUID)
      Connect a schema type to a schema attribute.
      void updateQueryTargetRelationship​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String derivedElementGUID, java.lang.String queryTargetGUID, DerivedSchemaTypeQueryTargetProperties queryTargetProperties)
      Update the relationship properties for the query target.
      void updateSchemaAttribute​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaAttributeGUID, boolean isMergeUpdate, SchemaAttributeProperties schemaAttributeProperties)
      Update the properties of the metadata element representing a schema attribute.
      void updateSchemaType​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties)
      Update the metadata element representing a schema type.
      • Methods inherited from class java.lang.Object

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