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

A data type can have a number of attributes that define its behaviour - size, precision, scale etc. This class encapsulates the information about a given named attribute. Attributes are also known as "create parameters" in the jdbc sql layer.

Since:

10.1.3

Nested Class Summary

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

AbstractDBObject.ChildSupport, AbstractDBObject.ListenerSupport

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATATYPE_CHAR Datatype is a number attribute
static java.lang.String	DATATYPE_IS_REF
static int	DATATYPE_LONG Datatype is a character attribute
static int	DATATYPE_LONG_OR_KEYWORD Datatype is either a number or a keyword value defined in property getValues()
static java.lang.String	DATATYPE_NAME
static java.lang.String	DATATYPE_PRECISION
static java.lang.String	DATATYPE_REF_SCOPE
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

Constructors

Constructor and Description
DataTypeAttribute()
DataTypeAttribute(java.lang.String name) Use this constructor for non declarable attributes.
DataTypeAttribute(java.lang.String name, int labelIndex, java.lang.String[] values, java.lang.String defaultValue, boolean isExtensible, boolean isMandatory) Deprecated.
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.
DataTypeAttribute(java.lang.String name, java.lang.String 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, java.lang.String 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, java.lang.String labelIndex, java.lang.String defaultValue, boolean isMandatory) Use this constructor for String attributes where the user enters the value e.g.

Method Summary

Methods

Modifier and Type	Method and Description
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()
void	setDeclarable(boolean isDeclarable)
void	setDefaultValue(java.lang.Object defaultValue)
void	setExtensible(boolean isExtensible)
void	setLabel(java.lang.String label)
void	setMandatory(boolean isMandatory)
void	setMaxValue(java.lang.Long maxValue)
void	setMinValue(java.lang.Long minValue)
void	setValues(java.lang.String[] values)
void	setValueType(int valueType)

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

setParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

addObjectListener, addObjectListener, addObjectListener, changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyTo, copyToImpl, equals, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, findOwnedObject, findParent, fireObjectUpdated, firePropertyChanged, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getParent, getProperties, getProperty, getProperty, getReferenceIDs, getReferenceIDsImpl, hashCode, includeOwnedObject, includesType, includesType, removeObjectListener, removeObjectListener, removeObjectListener, removeOwnedObject, 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.ChildDBObject

getParent

Methods inherited from interface oracle.javatools.db.DBObject

addObjectListener, copyTo, copyTo, copyTo, equals, findOwnedObject, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getProperties, getReferenceIDs, hashCode, removeObjectListener, removeOwnedObject, replaceReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

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_IS_REF

public static final java.lang.String DATATYPE_IS_REF

See Also:

Constant Field Values

DATATYPE_REF_SCOPE

public static final java.lang.String DATATYPE_REF_SCOPE

See Also:

Constant Field Values

DATATYPE_CHAR

public static final int DATATYPE_CHAR

Datatype is a number attribute

See Also:

Constant Field Values

DATATYPE_LONG

public static final int DATATYPE_LONG

Datatype is a character attribute

See Also:

Constant Field Values

DATATYPE_LONG_OR_KEYWORD

public static final int DATATYPE_LONG_OR_KEYWORD

Datatype is either a number or a keyword value defined in property getValues()

See Also:

getValues(), Constant Field Values

Constructor Detail

DataTypeAttribute

public DataTypeAttribute()

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

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 - minimum value allowed for the attribute

maxValue - maximum value allowed for the attribute

DataTypeAttribute

public DataTypeAttribute(java.lang.String name,
                 java.lang.String 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 - minimum value allowed for the attribute

maxValue - maximum value allowed for the 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,
                 java.lang.String 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 - ndex 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,
                 java.lang.String 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

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

Deprecated.

Method Detail

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.

getValueType

public int getValueType()

setValueType

public void setValueType(int valueType)

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String label)

getMinValue

public java.lang.Long getMinValue()

setMinValue

public void setMinValue(java.lang.Long minValue)

getMaxValue

public java.lang.Long getMaxValue()

setMaxValue

public void setMaxValue(java.lang.Long maxValue)

getValues

public java.lang.String[] getValues()

setValues

public void setValues(java.lang.String[] values)

getDefaultValue

public java.lang.Object getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

isDeclarable

public boolean isDeclarable()

setDeclarable

public void setDeclarable(boolean isDeclarable)

isMandatory

public boolean isMandatory()

setMandatory

public void setMandatory(boolean isMandatory)

isExtensible

public boolean isExtensible()

setExtensible

public void setExtensible(boolean isExtensible)