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

Class SchemaTypeBuilder

java.lang.Object

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

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

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

Direct Known Subclasses:

ComplexSchemaTypeBuilder

public class SchemaTypeBuilder
extends ReferenceableBuilder

SchemaTypeBuilder manages the properties for a schema type. These properties may be stored in a schema type entity or a type embedded attribute classification (linked off of schema attribute).

Field Summary

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

qualifiedName

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

classifications, errorHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

Constructor and Description
SchemaTypeBuilder(String qualifiedName, String displayName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Minimal constructor
SchemaTypeBuilder(String typeName, String qualifiedName, String displayName, String description, String versionNumber, boolean isDeprecated, String author, String usage, String encodingStandard, String namespace, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Constructor supporting all common properties.

Method Summary

Modifier and Type	Method and Description
InstanceProperties	getInstanceProperties(String methodName) Return the supplied bean properties in an InstanceProperties object.
InstanceProperties	getNameInstanceProperties(String methodName) Return the supplied bean properties that represent a name in an InstanceProperties object.
InstanceProperties	getQualifiedNameInstanceProperties(String methodName) Return the supplied bean properties that represent a name in an InstanceProperties object.
InstanceProperties	getTypeEmbeddedInstanceProperties(String methodName) Return the supplied bean properties in an InstanceProperties object for a TypeEmbeddedAttribute classification.
void	setDataType(String dataType) Set up the type of data (for simple and literal types)
void	setDefaultValue(String defaultValue) Set up the default value of a field (for simple types).
void	setFixedValue(String fixedValue) Set up the fixed data value (for literal types).
void	setMaximumElements(int maximumElements) Deprecated.
void	setTypeName(String typeName) Set up the unique name for the sub type of this element.

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

Constructor Detail

SchemaTypeBuilder

public SchemaTypeBuilder(String qualifiedName,
                         String displayName,
                         OMRSRepositoryHelper repositoryHelper,
                         String serviceName,
                         String serverName)

Minimal constructor

Parameters:

qualifiedName - unique name

displayName - new value for the display name.

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

SchemaTypeBuilder

public SchemaTypeBuilder(String typeName,
                         String qualifiedName,
                         String displayName,
                         String description,
                         String versionNumber,
                         boolean isDeprecated,
                         String author,
                         String usage,
                         String encodingStandard,
                         String namespace,
                         Map<String,String> additionalProperties,
                         Map<String,Object> extendedProperties,
                         OMRSRepositoryHelper repositoryHelper,
                         String serviceName,
                         String serverName)

Constructor supporting all common properties.

Parameters:

typeName - unique name of schema sub type

qualifiedName - unique name of schema type itself

displayName - new value for the display name.

description - description of the schema type.

versionNumber - version of the schema type.

isDeprecated - is the schema type deprecated

author - name of the author

usage - guidance on how the schema should be used.

encodingStandard - format of the schema.

namespace - namespace where the schema is defined.

additionalProperties - additional properties

extendedProperties - properties from the subtype.

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Detail

setTypeName

public void setTypeName(String typeName)

Set up the unique name for the sub type of this element.

Parameters:

typeName - string name

setDataType

public void setDataType(String dataType)

Set up the type of data (for simple and literal types)

Parameters:

dataType - string name

setDefaultValue

public void setDefaultValue(String defaultValue)

Set up the default value of a field (for simple types).

Parameters:

defaultValue - string value

setFixedValue

public void setFixedValue(String fixedValue)

Set up the fixed data value (for literal types).

Parameters:

fixedValue - string value

setMaximumElements

@Deprecated
public void setMaximumElements(int maximumElements)

Deprecated.

Set up the maximum number of elements allowed - zero for no limit. This property is deprecated because it is for BoundedSchemaType which is also deprecated.

Parameters:

maximumElements - int

getInstanceProperties

public InstanceProperties getInstanceProperties(String methodName)
                                         throws InvalidParameterException

Return the supplied bean properties in an InstanceProperties object.

Overrides:

getInstanceProperties in class ReferenceableBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

Throws:

InvalidParameterException - there is a problem with the properties

getTypeEmbeddedInstanceProperties

public InstanceProperties getTypeEmbeddedInstanceProperties(String methodName)
                                                     throws InvalidParameterException

Return the supplied bean properties in an InstanceProperties object for a TypeEmbeddedAttribute classification. If the caller uses this when there are extended properties defined for the builder then the call to create or add the entity will fail with invalid properties.

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

Throws:

InvalidParameterException - there is a problem with the properties

getNameInstanceProperties

public InstanceProperties getNameInstanceProperties(String methodName)

Return the supplied bean properties that represent a name in an InstanceProperties object.

Overrides:

getNameInstanceProperties in class ReferenceableBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

getQualifiedNameInstanceProperties

public InstanceProperties getQualifiedNameInstanceProperties(String methodName)

Return the supplied bean properties that represent a name in an InstanceProperties object.

Overrides:

getQualifiedNameInstanceProperties in class ReferenceableBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object