com.goldencode.p2j.persist

Class P2JField

java.lang.Object

com.goldencode.p2j.persist.P2JField

public class P2JField
extends java.lang.Object

Non-mutable container for DMO field definitions.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	caseSensitive Flag for case-sensitive character fields.
private java.lang.String	codePage Code page for the CLOB field.
private java.lang.String	columnLabel Column label.
private int	extent Extent size.
private java.lang.String	format Field format.
private int	hash Precomputed hash code.
private java.lang.String	help HELP attribute of this field.
private BaseDataType	initial Initial field value.
private java.lang.String	label Field label.
private boolean	mandatory true for mandatory (not null) fields.
private int	maxWidth The MAX-WIDTH, for CHARACTER fields.
private java.lang.String	name Field name.
private boolean	readOnly The READ-ONLY attribute of the field.
private int	scale The scale, for DECIMAL fields.
private boolean	serializeHidden Flag indicating the field should not be included in serialized output.
private java.lang.String	serializeName Name of field in serialized output.
private ParmType	type Field type.
private java.lang.String	validateExpression The VALIDATE-EXPRESSION for this field.
private java.lang.String	validateMessage The VALIDATE-MESSAGE for this field.
private java.lang.String	xmlDataType XML schema data type of field.
private java.lang.String	xmlNodeName Name of element or attribute representing field in XML output.
private java.lang.String	xmlNodeType Node type of field in XML output.

Constructor Summary

Constructors

Constructor and Description
P2JField(java.lang.String name, ParmType type, long extent, java.lang.String format, BaseDataType initial, java.lang.String label, java.lang.String columnLabel, boolean caseSensitive, java.lang.String codePage, java.lang.String help, boolean serializeHidden, java.lang.String serializeName, java.lang.String xmlDataType, java.lang.String xmlNodeName, java.lang.String xmlNodeType, boolean mandatory, int scale, int maxWidth) Convenience constructor.
P2JField(java.lang.String name, ParmType type, long extent, java.lang.String format, BaseDataType initial, java.lang.String label, java.lang.String columnLabel, boolean caseSensitive, java.lang.String codePage, java.lang.String help, boolean serializeHidden, java.lang.String serializeName, java.lang.String xmlDataType, java.lang.String xmlNodeName, java.lang.String xmlNodeType, boolean mandatory, int scale, int maxWidth, boolean readOnly, java.lang.String validateExpression, java.lang.String validateMessage) Convenience constructor.

Method Summary

Modifier and Type	Method and Description
private int	computeHash() Precompute the hashing value for this immutable object.
boolean	equals(java.lang.Object o) Test equivalence of this object and the given object in a way that is consistent with the implementation of hashCode().
java.lang.String	getCodePage() Get code page for the CLOB field.
java.lang.String	getColumnLabel() Get column label.
int	getExtent() Get extent size.
java.lang.String	getFormat() Get field format.
java.lang.String	getHelp() Get the field's help option.
BaseDataType	getInitial() Get initial value.
java.lang.String	getLabel() Get field label.
int	getMaxWidth() Obtains the MAX-WIDTH attribute.
java.lang.String	getName() Get field name.
int	getScale() Obtains the scale.
java.lang.String	getSerializeName() Get the field's serializeName option.
ParmType	getType() Get field type.
java.lang.String	getValidateExpression() Obtain the VALIDATE-EXPRESSION attribute.
java.lang.String	getValidateMessage() Obtain the VALIDATE-MESSAGE attribute.
java.lang.String	getXmlDataType() Get the field's xmlDataType option.
java.lang.String	getXmlNodeName() Get the field's xmlNodeName option.
java.lang.String	getXmlNodeType() Get the field's xmlNodeType option.
int	hashCode() Produce a hash code from the internal data of this object, which is consistent with the implementation of equals(Object).
boolean	isCaseSensitive() Check if this is a case sensitive field.
boolean	isMandatory() Checks if this is a mandatory (not null) field.
boolean	isReadOnly() Obtain the READ-ONLY attribute.
boolean	isSerializeHidden() Get the field's serializeHidden option.
java.lang.String	toString() Obtain a short (incomplete) description of the object held.
java.lang.String	toStringComplete() Get a string representation of a P2JField object that contains all/most information about the object.

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

Field name.

type

private final ParmType type

Field type.

extent

private final int extent

Extent size.

format

private final java.lang.String format

Field format.

initial

private final BaseDataType initial

Initial field value.

label

private final java.lang.String label

Field label.

columnLabel

private final java.lang.String columnLabel

Column label.

caseSensitive

private final boolean caseSensitive

Flag for case-sensitive character fields. Ignored for all other datatypes.

codePage

private final java.lang.String codePage

Code page for the CLOB field.

help

private final java.lang.String help

HELP attribute of this field.

serializeHidden

private final boolean serializeHidden

Flag indicating the field should not be included in serialized output.

serializeName

private final java.lang.String serializeName

Name of field in serialized output.

xmlDataType

private final java.lang.String xmlDataType

XML schema data type of field.

xmlNodeName

private final java.lang.String xmlNodeName

Name of element or attribute representing field in XML output.

xmlNodeType

private final java.lang.String xmlNodeType

Node type of field in XML output.

mandatory

private final boolean mandatory

true for mandatory (not null) fields.

scale

private final int scale

The scale, for DECIMAL fields.

maxWidth

private final int maxWidth

The MAX-WIDTH, for CHARACTER fields.

readOnly

private final boolean readOnly

The READ-ONLY attribute of the field.

validateExpression

private final java.lang.String validateExpression

The VALIDATE-EXPRESSION for this field.

validateMessage

private final java.lang.String validateMessage

The VALIDATE-MESSAGE for this field.

hash

private final int hash

Precomputed hash code.

Constructor Detail

P2JField

public P2JField(java.lang.String name,
                ParmType type,
                long extent,
                java.lang.String format,
                BaseDataType initial,
                java.lang.String label,
                java.lang.String columnLabel,
                boolean caseSensitive,
                java.lang.String codePage,
                java.lang.String help,
                boolean serializeHidden,
                java.lang.String serializeName,
                java.lang.String xmlDataType,
                java.lang.String xmlNodeName,
                java.lang.String xmlNodeType,
                boolean mandatory,
                int scale,
                int maxWidth)

Convenience constructor.

Parameters:

name - Field name.

type - Field type.

extent - Extent size.

format - Field format.

initial - Initial value.

label - Field label.

columnLabel - Column label.

caseSensitive - true for case-sensitive character fields.

codePage - Code page for the CLOB field.

help - Field's help option.

serializeHidden - Field's serialize-hidden option.

serializeName - Field's serialize-name option.

xmlDataType - Field's xml-data-type option.

xmlNodeName - Field's xml-node-name option.

xmlNodeType - Field's xml-node-type option.

mandatory - true for mandatory (not-null) fields.

scale - The scale, for decimal fields.

maxWidth - The MAX-WIDTH, for CHARACTER fields.

P2JField

public P2JField(java.lang.String name,
                ParmType type,
                long extent,
                java.lang.String format,
                BaseDataType initial,
                java.lang.String label,
                java.lang.String columnLabel,
                boolean caseSensitive,
                java.lang.String codePage,
                java.lang.String help,
                boolean serializeHidden,
                java.lang.String serializeName,
                java.lang.String xmlDataType,
                java.lang.String xmlNodeName,
                java.lang.String xmlNodeType,
                boolean mandatory,
                int scale,
                int maxWidth,
                boolean readOnly,
                java.lang.String validateExpression,
                java.lang.String validateMessage)

Convenience constructor.

Parameters:

name - Field name.

type - Field type.

extent - Extent size.

format - Field format.

initial - Initial value.

label - Field label.

columnLabel - Column label.

caseSensitive - true for case sensitive character fields.

codePage - Code page for the CLOB field.

help - Field's help option.

serializeHidden - Field's serialize-hidden option.

serializeName - Field's serialize-name option.

xmlDataType - Field's xml-data-type option.

xmlNodeName - Field's xml-node-name option.

xmlNodeType - Field's xml-node-type option.

mandatory - true for mandatory (not-null) fields.

scale - The scale, for decimal fields.

maxWidth - The MAX-WIDTH, for CHARACTER fields.

readOnly - The read-only attribute.

validateExpression - The validate expression, if any.

validateMessage - The validate message, if any.

Method Detail

getName

public java.lang.String getName()

Get field name.

Returns:

field name.

getType

public ParmType getType()

Get field type.

Returns:

field type.

getExtent

public int getExtent()

Get extent size.

Returns:

extent size.

getFormat

public java.lang.String getFormat()

Get field format.

Returns:

field format.

getInitial

public BaseDataType getInitial()

Get initial value.

Returns:

initial value.

getLabel

public java.lang.String getLabel()

Get field label.

Returns:

field label.

getColumnLabel

public java.lang.String getColumnLabel()

Get column label.

Returns:

column label.

isCaseSensitive

public boolean isCaseSensitive()

Check if this is a case sensitive field. It only make sense for character datatypes.

Returns:

true if this is a case-sensitive character field.

getCodePage

public java.lang.String getCodePage()

Get code page for the CLOB field.

Returns:

code page for the CLOB field.

isMandatory

public boolean isMandatory()

Checks if this is a mandatory (not null) field.

Returns:

true if this is a mandatory (not null) field.

getHelp

public java.lang.String getHelp()

Get the field's help option.

Returns:

See above.

isSerializeHidden

public boolean isSerializeHidden()

Get the field's serializeHidden option.

Returns:

See above.

getSerializeName

public java.lang.String getSerializeName()

Get the field's serializeName option.

Returns:

See above.

getXmlDataType

public java.lang.String getXmlDataType()

Get the field's xmlDataType option.

Returns:

See above.

getXmlNodeName

public java.lang.String getXmlNodeName()

Get the field's xmlNodeName option.

Returns:

See above.

getXmlNodeType

public java.lang.String getXmlNodeType()

Get the field's xmlNodeType option.

Returns:

See above.

getScale

public int getScale()

Obtains the scale. Only valid for decimal fields.

Returns:

the scale, for decimal fields.

getMaxWidth

public int getMaxWidth()

Obtains the MAX-WIDTH attribute. Only valid for character fields.

Returns:

the MAX-WIDTH, for character fields.

isReadOnly

public boolean isReadOnly()

Obtain the READ-ONLY attribute.

Returns:

the READ-ONLY attribute.

getValidateExpression

public java.lang.String getValidateExpression()

Obtain the VALIDATE-EXPRESSION attribute.

Returns:

the VALIDATE-EXPRESSION attribute.

getValidateMessage

public java.lang.String getValidateMessage()

Obtain the VALIDATE-MESSAGE attribute.

Returns:

the VALIDATE-MESSAGE attribute.

hashCode

public int hashCode()

Produce a hash code from the internal data of this object, which is consistent with the implementation of equals(Object).

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code.

equals

public boolean equals(java.lang.Object o)

Test equivalence of this object and the given object in a way that is consistent with the implementation of hashCode().

Overrides:

equals in class java.lang.Object

Returns:

true if this object is equivalent with o, else false.

toStringComplete

public java.lang.String toStringComplete()

Get a string representation of a P2JField object that contains all/most information about the object. The point of creating the method was to get a string representation unique for every distinct object.

Returns:

a string representation of all/most of the objects fields.

toString

public java.lang.String toString()

Obtain a short (incomplete) description of the object held. To be used only in debug routines.

Overrides:

toString in class java.lang.Object

Returns:

a short description of the most important attributes of the object.

computeHash

private int computeHash()

Precompute the hashing value for this immutable object.

Returns:

A hashing value based on all members of the object.