com.goldencode.p2j.persist

Class PropertyDefinition

java.lang.Object

com.goldencode.p2j.persist.PropertyDefinition

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class PropertyDefinition
extends java.lang.Object
implements java.io.Externalizable

Container for a DMO property's metadata: name, type and extent. Used to send the metadata of a DMO to a remote side, when remote appserver calls are involved. TODO: add the other schema attributes of a property definition: help, initial, mandatory, validateMessage, validationExpression, description, decimals (for decimal type), caseSensitive (for character type) codePage, serializeName, xmlNodeName, xmlDataType, etc. All these will be serialized only if schemaMarshalLevel == SM_FULL.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	caseSensitive Flag indicating the field is case-sensitive.
private java.lang.String	codePage Code page of the CLOB field.
private java.lang.String	columnLabel The column label of this property.
private int	extent The extent of this property, or NO_EXTENT if the property has no extent.
private java.lang.String	format The format of this property.
private java.lang.String	help HELP attribute of this field.
private java.lang.String	initial INITIAL attribute of this field.
private java.lang.String	label The label of this property.
private java.lang.String	legacyName The legacy name of this property.
private java.lang.String	name The name of this property.
private static int	NO_EXTENT Default value for no-extent properties.
private static java.util.Map<java.lang.String,java.lang.Class<?>>	primitiveClasses Map of primitive names to their classes.
private int	schemaMarshalLevel The SCHEMA-MARSHAL level for the parent temp-table.
private boolean	serializeHidden Flag indicating the field should not be included in serialized output.
private java.lang.Class<?>	type The P2J wrapper type of this property.
private java.lang.String	xmlNodeType Node type of field in XML output.

Constructor Summary

Constructors

Constructor and Description
PropertyDefinition() Default c'tor, explicitly added to allow instances of this class to be created on deserialization.
PropertyDefinition(Property prop) Create a new property definition.
PropertyDefinition(java.lang.String name, java.lang.Class<?> type) Create a new, no-extent, property definition.
PropertyDefinition(java.lang.String name, java.lang.Class<?> type, int extent) Create a new property definition.
PropertyDefinition(java.lang.String name, java.lang.Class<?> type, int extent, java.lang.String legacyName) Create a new property definition.
PropertyDefinition(java.lang.String name, java.lang.Class<?> type, int extent, java.lang.String legacyName, java.lang.String format, java.lang.String label, java.lang.String columnLabel) Create a new property definition.
PropertyDefinition(java.lang.String name, java.lang.Class<?> type, java.lang.String legacyName) Create a new, no-extent, property definition.
PropertyDefinition(java.lang.String name, java.lang.Class<?> type, java.lang.String legacyName, java.lang.String format, java.lang.String label, java.lang.String columnLabel) Create a new, no-extent, property definition.
PropertyDefinition(java.lang.String name, java.lang.String type) Create a new, no-extent, property definition.
PropertyDefinition(java.lang.String name, java.lang.String type, int extent) Create a new property definition.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCodePage() Get code page of this property.
java.lang.String	getColumnLabel() Get column label of this property.
int	getExtent() Get the extent of this property.
java.lang.String	getFormat() Get format of this property.
java.lang.String	getHelp() Get help text of this property.
java.lang.String	getInitial() Get initial value of this property.
java.lang.String	getLabel() Get label of this property.
java.lang.String	getLegacyName() Get legacy name of this property.
java.lang.String	getName() Get the name of this property.
java.lang.Class<?>	getType() Get the type of this property.
java.lang.String	getXmlNodeType() Get XML node type of this property.
boolean	isCaseSensitive() Get 'case-sensitive' flag of this property.
boolean	isExtent() Check if this property is an extent property.
boolean	isSerializeHidden() Get 'serialize hidden' flag of this property.
void	readExternal(java.io.ObjectInput in) Read the property definition from the specified input source.
void	setMarshalLevel(int schemaMarshalLevel) Configures the SCHEMA-MARSHAL level used for serialization of the property.
java.lang.String	toString() Get a string representation of this property.
private void	verifyType(java.lang.Class<?> type) Verify the given type is not null.
void	writeExternal(java.io.ObjectOutput out) Send the property definition to the specified output destination.

Methods inherited from class java.lang.Object

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

Field Detail

primitiveClasses

private static final java.util.Map<java.lang.String,java.lang.Class<?>> primitiveClasses

Map of primitive names to their classes.

NO_EXTENT

private static final int NO_EXTENT

Default value for no-extent properties.

See Also:

Constant Field Values

type

private java.lang.Class<?> type

The P2J wrapper type of this property.

extent

private int extent

The extent of this property, or NO_EXTENT if the property has no extent.

name

private java.lang.String name

The name of this property.

legacyName

private java.lang.String legacyName

The legacy name of this property.

format

private java.lang.String format

The format of this property.

label

private java.lang.String label

The label of this property.

columnLabel

private java.lang.String columnLabel

The column label of this property.

help

private java.lang.String help

HELP attribute of this field.

initial

private java.lang.String initial

INITIAL attribute of this field.

serializeHidden

private boolean serializeHidden

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

caseSensitive

private boolean caseSensitive

Flag indicating the field is case-sensitive.

xmlNodeType

private java.lang.String xmlNodeType

Node type of field in XML output.

codePage

private java.lang.String codePage

Code page of the CLOB field.

schemaMarshalLevel

private int schemaMarshalLevel

The SCHEMA-MARSHAL level for the parent temp-table. It is never SM_DEFAULT when object is to be serialized. Always SM_DEFAULT for a read object.

Constructor Detail

PropertyDefinition

public PropertyDefinition()

Default c'tor, explicitly added to allow instances of this class to be created on deserialization. Not for public use.

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                          java.lang.String type)
                   throws java.lang.ClassNotFoundException

Create a new, no-extent, property definition.

Parameters:

name - The name of this property.

type - The type of this property.

Throws:

java.lang.ClassNotFoundException - If the given type can not be resolved to a valid class.

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                          java.lang.String type,
                          int extent)
                   throws java.lang.ClassNotFoundException

Create a new property definition.

Parameters:

name - The name of this property.

type - The type of this property.

extent - The extent of this property.

Throws:

java.lang.ClassNotFoundException - If the given type can not be resolved to a valid class.

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                          java.lang.Class<?> type)

Create a new, no-extent, property definition.

Parameters:

name - The name of this property.

type - A class specifying the type of this property.

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                          java.lang.Class<?> type,
                          java.lang.String legacyName)

Create a new, no-extent, property definition.

Parameters:

name - The name of this property.

type - A class specifying the type of this property.

legacyName - The legacy name of this property.

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                          java.lang.Class<?> type,
                          int extent)

Create a new property definition.

Parameters:

name - The name of this property.

type - A class specifying the type of this property.

extent - The extent of this property.

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                          java.lang.Class<?> type,
                          int extent,
                          java.lang.String legacyName)

Create a new property definition.

Parameters:

name - The name of this property.

type - A class specifying the type of this property.

extent - The extent of this property.

legacyName - The legacy name of this property.

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                          java.lang.Class<?> type,
                          java.lang.String legacyName,
                          java.lang.String format,
                          java.lang.String label,
                          java.lang.String columnLabel)

Create a new, no-extent, property definition.

Parameters:

name - The name of this property.

type - A class specifying the type of this property.

legacyName - The legacy name of this property.

format - The format of this property.

label - The label of this property.

columnLabel - The column label of this property.

PropertyDefinition

public PropertyDefinition(java.lang.String name,
                          java.lang.Class<?> type,
                          int extent,
                          java.lang.String legacyName,
                          java.lang.String format,
                          java.lang.String label,
                          java.lang.String columnLabel)

Create a new property definition.

Parameters:

name - The name of this property.

type - A class specifying the type of this property.

legacyName - The legacy name of this property.

format - The format of this property.

label - The label of this property.

columnLabel - The column label of this property.

PropertyDefinition

public PropertyDefinition(Property prop)

Create a new property definition.

Parameters:

prop - The ORM field Property.

Method Detail

getType

public java.lang.Class<?> getType()

Get the type of this property.

Returns:

See above.

getExtent

public int getExtent()

Get the extent of this property.

Returns:

See above.

getName

public java.lang.String getName()

Get the name of this property.

Returns:

See above.

isExtent

public boolean isExtent()

Check if this property is an extent property.

Returns:

true if this property is an extent property.

getLegacyName

public java.lang.String getLegacyName()

Get legacy name of this property.

Returns:

legacy name of this property.

getFormat

public java.lang.String getFormat()

Get format of this property.

Returns:

format of this property.

getLabel

public java.lang.String getLabel()

Get label of this property.

Returns:

label of this property.

getColumnLabel

public java.lang.String getColumnLabel()

Get column label of this property.

Returns:

column label of this property.

getHelp

public java.lang.String getHelp()

Get help text of this property.

Returns:

help text of this property.

getInitial

public java.lang.String getInitial()

Get initial value of this property.

Returns:

initial value of this property.

isSerializeHidden

public boolean isSerializeHidden()

Get 'serialize hidden' flag of this property.

Returns:

'serialize hidden' flag of this property.

isCaseSensitive

public boolean isCaseSensitive()

Get 'case-sensitive' flag of this property.

Returns:

'case-sensitive' flag of this property.

getXmlNodeType

public java.lang.String getXmlNodeType()

Get XML node type of this property.

Returns:

XML node type of this property.

getCodePage

public java.lang.String getCodePage()

Get code page of this property.

Returns:

code page of this property.

writeExternal

public final void writeExternal(java.io.ObjectOutput out)
                         throws java.io.IOException

Send the property definition to the specified output destination.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which the property definition will be sent.

Throws:

java.io.IOException - In case of I/O errors.

readExternal

public final void readExternal(java.io.ObjectInput in)
                        throws java.io.IOException,
                               java.lang.ClassNotFoundException

Read the property definition from the specified input source.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which the property definition will be read.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If the class of property could not be found/loaded.

verifyType

private void verifyType(java.lang.Class<?> type)

Verify the given type is not null.

Parameters:

type - The type to check.

Throws:

java.lang.NullPointerException - If type is null.

toString

public java.lang.String toString()

Get a string representation of this property.

Overrides:

toString in class java.lang.Object

Returns:

See above.

setMarshalLevel

public void setMarshalLevel(int schemaMarshalLevel)

Configures the SCHEMA-MARSHAL level used for serialization of the property.

Parameters:

schemaMarshalLevel - The new SCHEMA-MARSHAL level. See AbstractTempTable static constants for details.