org.odpi.openmetadata.commonservices.generichandlers

Class SchemaAttributeBuilder

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

org.odpi.openmetadata.commonservices.generichandlers.SchemaAttributeBuilder

public class SchemaAttributeBuilder
extends ReferenceableBuilder

SchemaAttributeBuilder creates instance properties for a schema attribute.

Field Summary

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

qualifiedName

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

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

Constructor Summary

Constructors

Constructor and Description
SchemaAttributeBuilder(String qualifiedName, String displayName, String description, int elementPosition, int minCardinality, int maxCardinality, boolean isDeprecated, String defaultValueOverride, boolean allowsDuplicateValues, boolean orderedValues, int sortOrder, int minimumLength, int length, int significantDigits, boolean isNullable, String nativeJavaClass, List<String> aliases, Map<String,String> additionalProperties, String typeId, String typeName, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Constructor supporting all properties for a schema attribute entity.
SchemaAttributeBuilder(String qualifiedName, String displayName, String description, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Template constructor

Method Summary

Modifier and Type	Method and Description
InstanceProperties	getInstanceProperties(String methodName) Return the supplied bean properties in an InstanceProperties object.
SchemaTypeBuilder	getSchemaTypeBuilder() Return the schema type builder to the handler to add any extra elements.
void	setSchemaType(String userId, SchemaTypeBuilder schemaTypeBuilder, String methodName) The schema type can be stored in the TypeEmbeddedAttribute classification for the schema attribute entity.

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

getQualifiedName, setSecurityTags, setTemplate

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

getEntityClassificationProperties, getEntityClassifications, getExistingEntityClassificationHeader, getInstanceStatus, getTypeGUID, getTypeName, setAnchors, setClassification, setLatestChange, setTemplateClassifications

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaAttributeBuilder

public SchemaAttributeBuilder(String qualifiedName,
                              String displayName,
                              String description,
                              OMRSRepositoryHelper repositoryHelper,
                              String serviceName,
                              String serverName)

Template constructor

Parameters:

qualifiedName - unique name

displayName - new value for the display name

description - description of the schema attribute

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

SchemaAttributeBuilder

public SchemaAttributeBuilder(String qualifiedName,
                              String displayName,
                              String description,
                              int elementPosition,
                              int minCardinality,
                              int maxCardinality,
                              boolean isDeprecated,
                              String defaultValueOverride,
                              boolean allowsDuplicateValues,
                              boolean orderedValues,
                              int sortOrder,
                              int minimumLength,
                              int length,
                              int significantDigits,
                              boolean isNullable,
                              String nativeJavaClass,
                              List<String> aliases,
                              Map<String,String> additionalProperties,
                              String typeId,
                              String typeName,
                              Map<String,Object> extendedProperties,
                              OMRSRepositoryHelper repositoryHelper,
                              String serviceName,
                              String serverName)

Constructor supporting all properties for a schema attribute entity.

Parameters:

qualifiedName - unique name

displayName - new value for the display name.

description - new value for the description.

elementPosition - position of the attribute in the parent schemaType.

minCardinality - is the attribute optional?

maxCardinality - does the attribute repeat?

isDeprecated - is this element deprecated?

defaultValueOverride - override for the Type's default value.

allowsDuplicateValues - unique values ?

orderedValues - ordered values ?

sortOrder - sort order if ordered

minimumLength - minimum length of data in field

length - size of data field

significantDigits - number of digits on right of decimal point

isNullable - can the value be null?

nativeJavaClass - name of implementation class for Java

aliases - aliases for the field

additionalProperties - additional properties

typeName - name of the type for this schema element

typeId - unique identifier of the type for this schema element

extendedProperties - properties from the subtype.

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Detail

setSchemaType

public void setSchemaType(String userId,
                          SchemaTypeBuilder schemaTypeBuilder,
                          String methodName)
                   throws InvalidParameterException

The schema type can be stored in the TypeEmbeddedAttribute classification for the schema attribute entity. Depending on the type of schema, the schema type may require additional entities and relationships. The schemaTypeBuilder has this knowledge which is why the schemaTypeBuilder is saved. This method overrides any previously defined TypeEmbeddedAttribute classification for this entity.

Parameters:

userId - calling user

schemaTypeBuilder - builder containing the properties of the schema type

methodName - calling method

Throws:

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

getSchemaTypeBuilder

public SchemaTypeBuilder getSchemaTypeBuilder()

Return the schema type builder to the handler to add any extra elements.

Returns:

schema type builder object

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