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

Class SchemaAttributeBuilder

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

public class SchemaAttributeBuilder
extends ReferenceableBuilder

SchemaAttributeBuilder creates instance properties for a 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
SchemaAttributeBuilder(String qualifiedName, String attributeName, int elementPosition, String cardinality, String defaultValueOverride, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Deprecated.
SchemaAttributeBuilder(String qualifiedName, String attributeName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Minimal constructor
SchemaAttributeBuilder(String qualifiedName, String attributeName, String description, int elementPosition, int minCardinality, int maxCardinality, boolean isDeprecated, String defaultValueOverride, boolean allowsDuplicateValues, boolean orderedValues, DataItemSortOrder sortOrder, String anchorGUID, int minimumLength, int length, int significantDigits, boolean isNullable, String nativeJavaClass, List<String> aliases, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName) Constructor supporting all properties for a schema attribute entity.

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.
void	setFormula(String formula) Set up the formula for a derived schema attribute.

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

SchemaAttributeBuilder

public SchemaAttributeBuilder(String qualifiedName,
                              String attributeName,
                              OMRSRepositoryHelper repositoryHelper,
                              String serviceName,
                              String serverName)

Minimal constructor

Parameters:

qualifiedName - unique name

attributeName - new value for the display name.

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

SchemaAttributeBuilder

@Deprecated
public SchemaAttributeBuilder(String qualifiedName,
                                          String attributeName,
                                          int elementPosition,
                                          String cardinality,
                                          String defaultValueOverride,
                                          Map<String,String> additionalProperties,
                                          Map<String,Object> extendedProperties,
                                          OMRSRepositoryHelper repositoryHelper,
                                          String serviceName,
                                          String serverName)

Deprecated.

Constructor supporting original properties. Deprecated because uses old form of cardinality.

Parameters:

qualifiedName - unique name

attributeName - new value for the display name.

elementPosition - position of the attribute in the parent schemaType.

cardinality - does the attribute repeat?

defaultValueOverride - override for the Type's default value.

additionalProperties - additional properties

extendedProperties - properties from the subtype.

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

SchemaAttributeBuilder

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

Constructor supporting all properties for a schema attribute entity.

Parameters:

qualifiedName - unique name

attributeName - 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

anchorGUID - unique identifier of the anchor entity

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

extendedProperties - properties from the subtype.

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Detail

setFormula

public void setFormula(String formula)

Set up the formula for a derived schema attribute.

Parameters:

formula - formula used to derive the attribute value.

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

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