oracle.javatools.db.datatypes
Class DataTypeAttribute

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractChildDBObject
          oracle.javatools.db.datatypes.DataTypeAttribute

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class DataTypeAttribute
extends AbstractChildDBObject

Since:

10.1.3

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport

Field Summary

static int	DATATYPE_CHAR
static int	DATATYPE_LONG
static java.lang.String	DATATYPE_NAME
static java.lang.String	DATATYPE_PRECISION
static java.lang.String	DATATYPE_SCALE
static java.lang.String	DATATYPE_SIZE
static java.lang.String	DATATYPE_UNSIGNED
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

DataTypeAttribute()

DataTypeAttribute(java.lang.String name)
Use this constructor for non declarable attributes.

DataTypeAttribute(java.lang.String name, int labelIndex, long minValue, java.lang.Long maxValue, java.lang.Long defaultValue, boolean isMandatory)
Use this constructor for declarable numeric attributes, e.g.

DataTypeAttribute(java.lang.String name, int labelIndex, java.lang.String[] values, java.lang.String defaultValue, boolean isExtensible, boolean isMandatory)
Use this constructor for String attributes where there are one or more fixed values, e.g.

DataTypeAttribute(java.lang.String name, int labelIndex, java.lang.String defaultValue, boolean isMandatory)
Use this constructor for String attributes where the user enters the value e.g.

DataTypeAttribute(java.lang.String name, long minValue, long maxValue)
Use this constructor for numeric attributes which are not declared but are used in default value validation, e.g Oracle LONG, CLOB.

Method Summary

DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(DataTypeAttribute target, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(DataTypeAttribute target)
java.lang.Object	getDefaultValue()
java.lang.String	getLabel()
java.lang.Long	getMaxValue()
java.lang.Long	getMinValue()
java.lang.String	getType() Returns the type of this object.
java.lang.String[]	getValues()
int	getValueType()
boolean	isDeclarable()
boolean	isExtensible()
boolean	isMandatory()

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

copyToImpl, findParent, getParent, setParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, replaceReferenceIDs, setID, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.javatools.db.DBObject

copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

DATATYPE_NAME

public static final java.lang.String DATATYPE_NAME

See Also:

Constant Field Values

DATATYPE_SIZE

public static final java.lang.String DATATYPE_SIZE

See Also:

Constant Field Values

DATATYPE_PRECISION

public static final java.lang.String DATATYPE_PRECISION

See Also:

Constant Field Values

DATATYPE_SCALE

public static final java.lang.String DATATYPE_SCALE

See Also:

Constant Field Values

DATATYPE_UNSIGNED

public static final java.lang.String DATATYPE_UNSIGNED

See Also:

Constant Field Values

DATATYPE_CHAR

public static final int DATATYPE_CHAR

See Also:

Constant Field Values

DATATYPE_LONG

public static final int DATATYPE_LONG

See Also:

Constant Field Values

Constructor Detail

DataTypeAttribute

public DataTypeAttribute()

DataTypeAttribute

public DataTypeAttribute(java.lang.String name,
                         long minValue,
                         long maxValue)

Use this constructor for numeric attributes which are not declared but are used in default value validation, e.g Oracle LONG, CLOB.

Parameters:

name - : attribute name - must match an @name in the data type definition

minValue -

maxValue -

DataTypeAttribute

public DataTypeAttribute(java.lang.String name,
                         int labelIndex,
                         long minValue,
                         java.lang.Long maxValue,
                         java.lang.Long defaultValue,
                         boolean isMandatory)

Use this constructor for declarable numeric attributes, e.g. length, precision, scale. maxValue may be null if there is no absolute maximum, but is dependent upon another attribute, e.g. the scale of most definitions of DECIMAL must be less than or equal to its precision. It is up to the DataType class to interpret these values.

Parameters:

name - : attribute name - must match an @name in the data type definition

labelIndex - : index of display label for attribute

minValue -

maxValue -

defaultValue - : value of attribute when it's optional and not declared, value for UI when attribute is mandatory.

isMandatory - : TRUE if attribute must be declared

DataTypeAttribute

public DataTypeAttribute(java.lang.String name,
                         int labelIndex,
                         java.lang.String defaultValue,
                         boolean isMandatory)

Use this constructor for String attributes where the user enters the value e.g. the <value_list> of MySQL's SET(<value_list>) type.

Parameters:

name - : attribute name - must match an <attribute> in the data type definition

labelIndex - : index of display label for attribute

defaultValue - : value of attribute when it's optional and not declared, value for UI when attribute is mandatory.

isMandatory - : TRUE if attribute must be declared

DataTypeAttribute

public DataTypeAttribute(java.lang.String name,
                         int labelIndex,
                         java.lang.String[] values,
                         java.lang.String defaultValue,
                         boolean isExtensible,
                         boolean isMandatory)

Use this constructor for String attributes where there are one or more fixed values, e.g. the <unit> of Oracle's CHAR[(<size>[ <unit>]) type.

Parameters:

name - : attribute name - must match an <attribute> in the data type definition

labelIndex - : index of display label for attribute

values - : array of string values to populate pick list

defaultValue - : value of attribute when it's optional and not declared, value for UI when attribute is mandatory.

isExtensible - : TRUE if user entered values can be added

isMandatory - : TRUE if attribute must be declared

DataTypeAttribute

public DataTypeAttribute(java.lang.String name)

Use this constructor for non declarable attributes.

Parameters:

name - : attribute name - must match an @name in the data type definition

Method Detail

getValueType

public int getValueType()

getLabel

public java.lang.String getLabel()

getMinValue

public java.lang.Long getMinValue()

getMaxValue

public java.lang.Long getMaxValue()

getValues

public java.lang.String[] getValues()

getDefaultValue

public java.lang.Object getDefaultValue()

isDeclarable

public boolean isDeclarable()

isMandatory

public boolean isMandatory()

isExtensible

public boolean isExtensible()

getType

public final java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:

a string describing the type of object.

equals

public boolean equals(java.lang.Object target)

Overrides:

equals in class java.lang.Object

equalsImpl

protected boolean equalsImpl(DataTypeAttribute target)

copyTo

public DBObject copyTo(DBObject target,
                       DBObject copyParent,
                       IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Internal copy method used by the API to perform copy operations. All objects must implement this method if they are instantiable objects. Abstract objects (e.g. Relation) must NOT implement this method. The implementation should delegate to the copyToImpl method to copy the actual properties.

This method does not fix internal reference ids on copy. That is done by the calling DBObject.copyTo(DBObject, IDPolicy) method.

Specified by:

copyTo in class AbstractDBObject

See Also:

DBObject.copyTo(java.lang.Object), DBObject.copyTo(DBObject, boolean), AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)

copyToImpl

protected void copyToImpl(DataTypeAttribute target,
                          DBObject copyParent,
                          IDPolicy idPolicy)