oracle.ifs.beans

Class AttributeDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SchemaObjectDefinition

oracle.ifs.beans.AttributeDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class AttributeDefinition
extends SchemaObjectDefinition

An AttributeDefinition is a template for creating an Attribute. Once you have created an attribute definition, add it to a ClassObjectDefition to create a custom subclass.

Version:

1.0

Author:

David Pitfield

See Also:

Attribute, ClassObjectDefinition, Serialized Form

(Published)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMON_NAME_SYSTEMOPTION_NAME The name of the system option that contains the common name to associate with the Attribute being created.
static String	DEFINITIONSETTINGPOLICY_SYSTEMOPTION_NAME The name of the system option containing the policy of applying a setting in a LibraryObjectDefinition for an Attribute in the applySettings method in LibraryObjectDefinition classes.
static String	DROP_COLUMN_SYSTEMOPTION_NAME The name of the system option whose boolean AttributeValue controls whether, in removing an attribute from a ClassObject, that attribute's column in the base table is dropped or marked unused.
static String	EXISTING_COLUMN_SYSTEMOPTION_NAME The name of the system option whose string AtributeValue is the name of an existing column in the base table for this attribute's ClassObject.
static String	EXISTING_INDEX_SYSTEMOPTION_NAME The name of the system option whose string AttributeValue is the name of the index on the attribute's column in the ClassObject's base table.
static String	MULTIVALUE_TABLE_SUFFIX_SYSTEMOPTION_NAME The name of the system option whose string is the table name suffix used to derive the table name for the map or array values used for the Attribute being defined.
static String	STANDARD_SIMPLEPROPERTY_ARRAY_SYSTEMOPTION_NAME The name of the system option containing an indication as to whether the Attribute implements "standard SimpleProperty array" semantics.

Fields inherited from class oracle.ifs.beans.SchemaObjectDefinition

m_CategoryDefs

Fields inherited from class oracle.ifs.beans.LibraryObjectDefinition

m_Attributes, m_ClassObjectName, m_ClassObjectValue, m_ContentSpecifications, m_DefinitionLists, m_Definitions, m_EnclosedDefinition, m_Id, m_Options, m_ReadOnly, m_ReferenceAttributes, m_Session, m_SystemOptions

Constructor Summary

Constructors

Constructor and Description
AttributeDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
AttributeDefinition(LibrarySessionInterface session, String className) Construct a definition, explicitly capturing the session and setting the initial classobject.

Method Summary

Modifier and Type	Method and Description
String	getCommonName() Get the common name.
String	getDefinitionSettingPolicy() Gets the policy in effect for applying a definition setting for the Attribute.
String	getMultiValueTableSuffix() Get the table suffix to use for a map or array type Attribute.
Boolean	getStandardSimplePropertyArray() Gets the indication as to whether the Attribute should implement "standard" semantics for a SimpleProperty array.
void	setCommonName(String commonName) Set the common name.
void	setDefinitionSettingPolicy(String policyName) Sets the policy in effect for applying a definition setting for the Attribute.
void	setMultiValueTableSuffix(String tableSuffix) Set the table suffix to use for a map or array type Attribute.
void	setStandardSimplePropertyArray(Boolean isStandard) Sets the indication as to whether the Attribute should implement "standard" semantics for a SimpleProperty array.
static AttributeDefinition	toAttributeDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a AttributeDefinition.
static AttributeDefinition	toAttributeDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a AttributeDefinition.
protected static AttributeDefinition[]	vectorToAttributeDefinitionArray(Vector vector) Internal use only: Converts a vector of AttributeDefinitions to an AttributeDefinition array.

Methods inherited from class oracle.ifs.beans.SchemaObjectDefinition

addCategoryDefinition, addCategoryDefinitions, applySettings, getCategoryDefinitions, removeCategoryDefinitions, setCategoryDefinitions, toSchemaObjectDefinition, toSchemaObjectDefinition

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

addDefinition, addDefinitions, addProperty, addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addSimplePropertyDefinition, addSimplePropertyDefinition, addSimplePropertyDefinitions, addSimplePropertyDefinitions, applyEnumSetting, applyEnumSetting, applyMapSetting, applyMapSetting, applyObjectArraySetting, applyObjectArraySetting, applyObjectSetting, applyObjectSetting, applySetting, applySetting, captureSession, captureSession, captureSession, clone, constructInstance, constructInstance, constructInstance, copyInto, deriveObjectArraySetting, deriveObjectSetting, getAttribute, getAttribute, getAttributes, getAttributes, getAttributesSorted, getClassId, getClassObject, getClassObjectValue, getContentSpecification, getContentSpecificationKeys, getCopiedObjectValue, getDefinition, getDefinitionClassName, getDefinitionKeys, getDefinitionListKeys, getDefinitions, getId, getLibrarySession, getName, getOption, getOptionAsAttributeValue, getOptionKeys, getPolicyMode, getPropertyDefinitions, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, prepareForDefinitionObject, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, removePropertyDefinitions, removeReferenceAttribute, removeSimplePropertyDefinitions, removeSystemOption, reset, resolve, setAttribute, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributeByUpperCaseName, setAttributePolicyMode, setAttributes, setClassId, setClassname, setClassObject, setClassObjectValue, setContentSpecification, setCopiedObjectValue, setDefinition, setDefinitions, setId, setName, setOption, setReadOnly, setReferenceAttribute, setReferenceAttribute, setSession, setSimplePropertyDefinitions, setSystemOption, unresolve, verifySession

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_NAME_SYSTEMOPTION_NAME

public static final String COMMON_NAME_SYSTEMOPTION_NAME

The name of the system option that contains the common name to associate with the Attribute being created.

If specified, this name gets saved as an property in the Attribute's PropertyBundle, if the Attribute has an associated PropertyBundle defined.

See Also:

Constant Field Values

EXISTING_COLUMN_SYSTEMOPTION_NAME

public static final String EXISTING_COLUMN_SYSTEMOPTION_NAME

The name of the system option whose string AtributeValue is the name of an existing column in the base table for this attribute's ClassObject.

If this system option is specified in the AttributeDefinition used to add an attribute to an existing ClassObject, then the repository will use the existing column to store the new attribute's values, rather than the default behavior of adding a new column. It is the caller's responsibility to ensure the system option's value identifies a column that already exists and whose definition and properties are compatible with the new attribute. If the existing column has a name different than the DATABASEOBJECTNAME of the new attribute, the existing column is automatically renamed.

See Also:

Constant Field Values

(Unpublished)

EXISTING_INDEX_SYSTEMOPTION_NAME

public static final String EXISTING_INDEX_SYSTEMOPTION_NAME

The name of the system option whose string AttributeValue is the name of the index on the attribute's column in the ClassObject's base table.

If this system option is specified in the AttributeDefinition used to add an attribute to an existing ClassObject, then the repository will use the existing index, rather than the default behavior of creating a new index. It is the caller's responsibility to ensure the system option's value identifies an index that already exists and whose definition and properties are consistent with the new attribute. The existing index will be renamed to a name synthesized from the id of the new attribute.

See Also:

Constant Field Values

(Unpublished)

DROP_COLUMN_SYSTEMOPTION_NAME

public static final String DROP_COLUMN_SYSTEMOPTION_NAME

The name of the system option whose boolean AttributeValue controls whether, in removing an attribute from a ClassObject, that attribute's column in the base table is dropped or marked unused.

The default behavior is to drop the column (ALTER TABLE ... DROP COLUMN). However, if this system option is set false in the AttributeDefinition supplied in removing an attribute from a ClassObject, the repository will instead mark the column unused (ALTER TABLE ... SET UNUSED COLUMN).

See Also:

Constant Field Values

(Unpublished)

MULTIVALUE_TABLE_SUFFIX_SYSTEMOPTION_NAME

public static final String MULTIVALUE_TABLE_SUFFIX_SYSTEMOPTION_NAME

The name of the system option whose string is the table name suffix used to derive the table name for the map or array values used for the Attribute being defined.

If this system option is specified in the AttributeDefinition used to add an attribute to an existing ClassObject, then the values stored for that Attribute will use the table name as indicated by this suffix. Otherwise, a default table name will be used for each data type, for example "odmzm_stringstringmap" for data type 30.

See Also:

Constant Field Values

(Unpublished)

STANDARD_SIMPLEPROPERTY_ARRAY_SYSTEMOPTION_NAME

public static final String STANDARD_SIMPLEPROPERTY_ARRAY_SYSTEMOPTION_NAME

The name of the system option containing an indication as to whether the Attribute implements "standard SimpleProperty array" semantics.

See Also:

Constant Field Values

(Unpublished)

DEFINITIONSETTINGPOLICY_SYSTEMOPTION_NAME

public static final String DEFINITIONSETTINGPOLICY_SYSTEMOPTION_NAME

The name of the system option containing the policy of applying a setting in a LibraryObjectDefinition for an Attribute in the applySettings method in LibraryObjectDefinition classes.

See Also:

Constant Field Values

(Unpublished)

Constructor Detail

AttributeDefinition

public AttributeDefinition(LibrarySessionInterface session)
                    throws IfsException

Construct a definition explicitly capturing the session. The initial ClassObject will be Attribute.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

AttributeDefinition

public AttributeDefinition(LibrarySessionInterface session,
                           String className)
                    throws IfsException

Construct a definition, explicitly capturing the session and setting the initial classobject.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

setCommonName

public void setCommonName(String commonName)
                   throws IfsException

Set the common name.

Parameters:

commonName - the common name

Throws:

IfsException - if operation fails.

(Published)

getCommonName

public String getCommonName()
                     throws IfsException

Get the common name.

Returns:

the common name; or null if this option was not set

Throws:

IfsException - if operation fails.

(Published)

setMultiValueTableSuffix

public void setMultiValueTableSuffix(String tableSuffix)
                              throws IfsException

Set the table suffix to use for a map or array type Attribute.

Parameters:

tableSuffix - the table suffix to use in deriving the map/array value table name

Throws:

IfsException - if operation fails.

(Unpublished)

getMultiValueTableSuffix

public String getMultiValueTableSuffix()
                                throws IfsException

Get the table suffix to use for a map or array type Attribute.

Returns:

the table suffix to use in deriving the map/array value table name; or null if this option was not set

Throws:

IfsException - if operation fails.

(Unpublished)

setStandardSimplePropertyArray

public void setStandardSimplePropertyArray(Boolean isStandard)
                                    throws IfsException

Sets the indication as to whether the Attribute should implement "standard" semantics for a SimpleProperty array.

Parameters:

isStandard - true if this attribue implements the standard semantic

Throws:

IfsException - if operation fails.

(Unpublished)

getStandardSimplePropertyArray

public Boolean getStandardSimplePropertyArray()
                                       throws IfsException

Gets the indication as to whether the Attribute should implement "standard" semantics for a SimpleProperty array.

Returns:

true if this attribue implements the standard semantic; false otherwise

Throws:

IfsException - if operation fails.

(Unpublished)

setDefinitionSettingPolicy

public void setDefinitionSettingPolicy(String policyName)
                                throws IfsException

Sets the policy in effect for applying a definition setting for the Attribute.

Parameters:

policyName - the policy name

Throws:

IfsException - if operation fails.

(Unpublished)

getDefinitionSettingPolicy

public String getDefinitionSettingPolicy()
                                  throws IfsException

Gets the policy in effect for applying a definition setting for the Attribute.

Returns:

the policy name

Throws:

IfsException - if operation fails.

(Unpublished)

toAttributeDefinition

public static AttributeDefinition toAttributeDefinition(LibraryObjectDefinition lodef)
                                                 throws IfsException

Cast specified LibraryObjectDefinition to a AttributeDefinition.

Return null if the specified definition is not a AttributeDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

a AttributeDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toAttributeDefinition

public static AttributeDefinition toAttributeDefinition(LibraryObjectDefinition lodef,
                                                        boolean enforceCompat)
                                                 throws IfsException

Cast specified LibraryObjectDefinition to a AttributeDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw an IfsException if the specified definition is not a AttributeDefinition.

Parameters:

lodef - the definition to be casted

enforceCompat - whether to throw an exception if a non-null definition cannot be cast

Returns:

a AttributeDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)

vectorToAttributeDefinitionArray

protected static AttributeDefinition[] vectorToAttributeDefinitionArray(Vector vector)
                                                                 throws IfsException

Internal use only: Converts a vector of AttributeDefinitions to an AttributeDefinition array.

For internal use only. Do not use this method.

Parameters:

vector - the vector

Returns:

the array

Throws:

IfsException - if an error occurs

(Unpublished)