de.ipcon.schema.types

Class WrappingArrayType

java.lang.Object

de.ipcon.schema.types.CBOAbstractAttributeType

de.ipcon.schema.types.WrappingArrayType

All Implemented Interfaces:

CBOAttributeTypeI

public class WrappingArrayType
extends CBOAbstractAttributeType

A generic array type implementation that is able to use nearly any basic CBOAttributeTypeI as component. Uses a json compatible (un-)marshalling format. Allows to delegate the (un-)marshalling for the GUI representation of each element to be delegated to the componentTypes conversion rules. Allows and delegates configuration information for each element to the componentTypes implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigureInfo	CONFIG Provides the following additional attributes for value validation of nonnull arrays: minElements: the size of the array should be equal or greater than this number maxElements: the size of the array should be equal or less than this number allowNullElements: For nonnull arrays: true (default) - null is a valid element, false - each element in the array has to be nonnull.
static java.lang.Integer	DEFAULT_WIDTH
static java.math.BigDecimal[]	EMPTY_BigDecimal
static java.lang.Boolean[]	EMPTY_Boolean
static java.util.Date[]	EMPTY_Date
static electric.xml.Document[]	EMPTY_Document
static java.lang.Double[]	EMPTY_Double
static javax.xml.datatype.Duration[]	EMPTY_Duration
static java.lang.Float[]	EMPTY_Float
static java.lang.Integer[]	EMPTY_Integer
static java.lang.Long[]	EMPTY_Long
static java.lang.String[]	EMPTY_String
static java.net.URI[]	EMPTY_URI
static org.apache.log4j.Logger	log

Fields inherited from class de.ipcon.schema.types.CBOAbstractAttributeType

OQL_NULL_STRING

Fields inherited from interface de.ipcon.schema.CBOAttributeTypeI

INDEX_TYPE_AUTO, INDEX_TYPE_BRIN, INDEX_TYPE_BRIN_FB_BTREE, INDEX_TYPE_BTREE, INDEX_TYPE_CUSTOM, INDEX_TYPE_GIN, INDEX_TYPE_GIN_FB_BTREE, INDEX_TYPE_NONE, INDEX_TYPE_TRIGRAM, INDEX_TYPES, INDEX_TYPES_HR, NO_CUSTOM_INDEX_VERSION

Constructor Summary

Constructors

Constructor and Description
WrappingArrayType(CBOAttributeTypeI cType)
WrappingArrayType(CBOAttributeTypeI cType, boolean useComponentsTextGUI)
WrappingArrayType(CBOAttributeTypeI baseOrComponentType, electric.xml.Element parms) Constructor of a new array type for either another array type or a single component 2 cases: 1. extends ends on [] -> extends name-[] is actually our component, we do not have an explicit wrappingBase.

Method Summary

Modifier and Type	Method and Description
void	applyAdditionalEtters(CBOAttributeI attr, SourceGeneratorI src) Same as CBOAttributeTypeI.applyAdditionalEtters(java.lang.String, de.ipcon.schema.generators.SourceGeneratorI, boolean) but with more information about the attribute to generate the Etters for. e.g. special handling for virtual and writable attributes.
void	applyAdditionalEtters(java.lang.String pn, SourceGeneratorI src, boolean getterOnly) Generates NN-getters, returning an empty array as fallback.
boolean	applySetHook(java.lang.String vn, MethodGeneratorI setmeth) Copy-on-write of the parameter to prevent modification of the internal field after its values have been recorded.
void	checkConstraints(java.lang.Object value) Checks the array constraints as well as optional constraints on each element
java.lang.Boolean	getAllowNullElements()
java.lang.String	getAsString(java.lang.Object o)
java.lang.Class	getBaseTypeClass() Extracts the base type class for the java type.
java.lang.String	getCastorCollectionType() Type of the collection or null, if not a collectionfor generating the castor mapping file.
java.lang.String	getCastorFieldType() From the Castor docs: "The field element includes an optional attribute called type which can be used to specify the Java type of the field.
java.lang.String	getCastorSqlType() From the Castor docs: "Castor JDO implements automatic type conversion between Java and SQL.
CBOAttributeTypeI	getComponent()
java.lang.String	getComponentSqlType() If this is a CBOAttributeTypeI.getCastorCollectionType() with an explicit component type, then returns the SQL column type the component.
java.lang.String	getComponentTypeName() The type name of the component
java.lang.String	getDAUType() User-friendly l10n-ed name for the type, to be used for user interaction.
java.lang.String	getExternalizePostfix() Used for the Schema serialization/diffs and for the naming of the read/write externalization methods (of which the standard set is defined in de.ipcon.db.core.BO).
java.lang.Class	getJavaClass() The not null type/Class of the field in the Java object (the MyTISM BO).
AttributeTypeCodeGen<JavaMethodGen,JavaClassGen,WrappingArrayType>	getJavaCodeGen(java.lang.String attrName)
int	getJdbcType() Type/Class that the JDBC driver returns for the column/field.
java.lang.Integer	getMaxElements()
java.lang.Integer	getMinElements()
java.lang.String	getName()
AttributeTypeCodeGen<nrxmethod,nrxgen,WrappingArrayType>	getNRXCodeGen(java.lang.String attrName)
java.lang.String	getSqlType() SQL column type in the relational database.
java.lang.Integer	getStandardExpectedWidth()
java.lang.Boolean	getUseComponentsGUIText()
void	handleElementE(electric.xml.Element el) Dummy handle for element of the parms configuration.
boolean	hasAdditionalEtters()
boolean	hasSetHook()
boolean	isComponentMandatory()
boolean	isComponentsGUIText()
java.lang.String	marshal(java.lang.Object o)
void	setAllowNullElements(java.lang.Boolean $13)
void	setMaxElements(java.lang.Integer $12)
void	setMinElements(java.lang.Integer $11)
void	setUseComponentsGUIText(java.lang.Boolean $14)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String s)
java.lang.Object	unMarshal(java.lang.String s)

Methods inherited from class de.ipcon.schema.types.CBOAbstractAttributeType

allowsValue, applyCustomExternalization, applySetBOLoaderHook, castToNumber, castToOwnType, checkConstraints, compare, compareImpl, configure, formatAsInlineParameter, formatAsInlineParameter, getAsString, getAsString, getAsString, getBase, getBool, getCastorJavaClass, getDef, getDefinition, getExpectedWidth, getFilter, getFloat, getIndexType, getInt, getLong, getNullable, getPositiveInt, getUnique, hasCustomExternalization, hasSetBOLoaderHook, isCore, isIndexed, isMandatory, marshal, nullable, setAsString, setAsString, setAsString, setBase, setDef, setExpectedWidth, setIndexType, setNullable, setUnique, stringToValue, stringToValue, stringToValue, stringToValue, stringToValueWithTypeTip, stringToValueWithTypeTip, stringToValueWithTypeTip, stringToValueWithTypeTip, toXML, toXMLString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.schema.CBOAttributeTypeI

getAsUserFriendlyRawString, getHumanReadableIndexType, getJavaClassFQNForImport, getJavaClassnameForCode, getNonNullDefaultValue, getNullDefaultType

Field Detail

log

public static final org.apache.log4j.Logger log

CONFIG

public static final ConfigureInfo CONFIG

Provides the following additional attributes for value validation of nonnull arrays:

• minElements: the size of the array should be equal or greater than this number
• maxElements: the size of the array should be equal or less than this number
• allowNullElements: For nonnull arrays: true (default) - null is a valid element, false - each element in the array has to be nonnull.

Each component value can be limited based on the available configuration of that elements type, by providing the component parms-element in a sub-element named element, e.g. a numeric array with only nonnull and positive numbers: <parms allowNullElements="false"><element><parms minInclusiveLimit="0"/></element></parms>

DEFAULT_WIDTH

public static final java.lang.Integer DEFAULT_WIDTH

EMPTY_BigDecimal

public static final java.math.BigDecimal[] EMPTY_BigDecimal

EMPTY_Boolean

public static final java.lang.Boolean[] EMPTY_Boolean

EMPTY_Date

public static final java.util.Date[] EMPTY_Date

EMPTY_Document

public static final electric.xml.Document[] EMPTY_Document

EMPTY_Double

public static final java.lang.Double[] EMPTY_Double

EMPTY_Duration

public static final javax.xml.datatype.Duration[] EMPTY_Duration

EMPTY_Float

public static final java.lang.Float[] EMPTY_Float

EMPTY_Integer

public static final java.lang.Integer[] EMPTY_Integer

EMPTY_Long

public static final java.lang.Long[] EMPTY_Long

EMPTY_String

public static final java.lang.String[] EMPTY_String

EMPTY_URI

public static final java.net.URI[] EMPTY_URI

Constructor Detail

WrappingArrayType

public WrappingArrayType(CBOAttributeTypeI cType)

WrappingArrayType

public WrappingArrayType(CBOAttributeTypeI cType,
                         boolean useComponentsTextGUI)

WrappingArrayType

public WrappingArrayType(CBOAttributeTypeI baseOrComponentType,
                         electric.xml.Element parms)

Constructor of a new array type for either another array type or a single component 2 cases: 1. extends ends on [] -> extends name-[] is actually our component, we do not have an explicit wrappingBase. (Element, CBOAttributeTypeI) constructor 2. extends doesn't end on [] -> base has to be an wrappingArrayType which we extend and copy the componentType over. Default (Element, CBOAttributeTypeI) constructor

Method Detail

handleElementE

public void handleElementE(electric.xml.Element el)

Dummy handle for element of the parms configuration. Does nothing. Called via reflection by ConfigureInfo.

getComponent

public CBOAttributeTypeI getComponent()

getComponentTypeName

public java.lang.String getComponentTypeName()

The type name of the component

isComponentMandatory

public boolean isComponentMandatory()

Returns:

true if each component needs to be a nonnull value (default). false otherwise.inheritable

isComponentsGUIText

public boolean isComponentsGUIText()

getStandardExpectedWidth

public java.lang.Integer getStandardExpectedWidth()

getJdbcType

public final int getJdbcType()

Description copied from interface: CBOAttributeTypeI

Type/Class that the JDBC driver returns for the column/field. What this actually is partly depends on the actual driver used - at least if you want to store stuff out of the ordinary (that is something other than simple strings, numbers, booleans, etc.).

getExternalizePostfix

public final java.lang.String getExternalizePostfix()

Description copied from interface: CBOAttributeTypeI

Used for the Schema serialization/diffs and for the naming of the read/write externalization methods (of which the standard set is defined in de.ipcon.db.core.BO).

getDAUType

public java.lang.String getDAUType()

Description copied from interface: CBOAttributeTypeI

User-friendly l10n-ed name for the type, to be used for user interaction.

getName

public java.lang.String getName()

getCastorCollectionType

public final java.lang.String getCastorCollectionType()

Description copied from interface: CBOAttributeTypeI

Type of the collection or null, if not a collectionfor generating the castor mapping file. e.g. (null | array | vector | hashtable | collection | set | map)

Specified by:

getCastorCollectionType in interface CBOAttributeTypeI

Overrides:

getCastorCollectionType in class CBOAbstractAttributeType

Returns:

the collection type array for Castor, which is paired with the CastorFieldType to create an array type.

getCastorFieldType

public java.lang.String getCastorFieldType()

Description copied from interface: CBOAttributeTypeI

From the Castor docs: "The field element includes an optional attribute called type which can be used to specify the Java type of the field. This attribute is optional since Castor can always derive the exact Java type from the class definition. We highly recommend that developers use the type field in their mapping file as a means to provide static type checking. When loading a mapping file, Castor will compare the actual Java type with the type specified in the mapping and will complain about inconsistencies."

getCastorSqlType

public final java.lang.String getCastorSqlType()

Description copied from interface: CBOAttributeTypeI

From the Castor docs: "Castor JDO implements automatic type conversion between Java and SQL. For this mechanism to work, the mapping file must specify the SQL type being used for Castor to employ the proper convertor. If no SQL type is specified, no conversion will occur, possibly resulting in an IllegalArgumentException being thrown."

getSqlType

public java.lang.String getSqlType()

Description copied from interface: CBOAttributeTypeI

SQL column type in the relational database. Must be supported by de.ipcon.schema.generators.PostgreSQLColumn.normalizeColumnType().

getComponentSqlType

public java.lang.String getComponentSqlType()

Description copied from interface: CBOAttributeTypeI

If this is a CBOAttributeTypeI.getCastorCollectionType() with an explicit component type, then returns the SQL column type the component. Null, if not a collectionType.

Specified by:

getComponentSqlType in interface CBOAttributeTypeI

Overrides:

getComponentSqlType in class CBOAbstractAttributeType

getJavaClass

public java.lang.Class getJavaClass()

Description copied from interface: CBOAttributeTypeI

The not null type/Class of the field in the Java object (the MyTISM BO).

getBaseTypeClass

public java.lang.Class getBaseTypeClass()

Extracts the base type class for the java type.

getJavaCodeGen

public AttributeTypeCodeGen<JavaMethodGen,JavaClassGen,WrappingArrayType> getJavaCodeGen(java.lang.String attrName)

getNRXCodeGen

public AttributeTypeCodeGen<nrxmethod,nrxgen,WrappingArrayType> getNRXCodeGen(java.lang.String attrName)

hasSetHook

public boolean hasSetHook()

Specified by:

hasSetHook in interface CBOAttributeTypeI

Overrides:

hasSetHook in class CBOAbstractAttributeType

applySetHook

public boolean applySetHook(java.lang.String vn,
                            MethodGeneratorI setmeth)

Copy-on-write of the parameter to prevent modification of the internal field after its values have been recorded. Special handling for mutable component types

Specified by:

applySetHook in interface CBOAttributeTypeI

Overrides:

applySetHook in class CBOAbstractAttributeType

hasAdditionalEtters

public boolean hasAdditionalEtters()

Specified by:

hasAdditionalEtters in interface CBOAttributeTypeI

Overrides:

hasAdditionalEtters in class CBOAbstractAttributeType

Returns:

true if this type wants to add additional setter or getter code to the generated Base classes, false otherwise

applyAdditionalEtters

public void applyAdditionalEtters(java.lang.String pn,
                                  SourceGeneratorI src,
                                  boolean getterOnly)

Generates NN-getters, returning an empty array as fallback.

Parameters:

pn - the attribute name to generate the *etters for, nonnull.

src - the nrx generator to extend

getterOnly - true if the attribute is virtual and readonly, false otherwise. If true, only getter methods should be generated.

applyAdditionalEtters

public void applyAdditionalEtters(CBOAttributeI attr,
                                  SourceGeneratorI src)

Description copied from interface: CBOAttributeTypeI

Same as CBOAttributeTypeI.applyAdditionalEtters(java.lang.String, de.ipcon.schema.generators.SourceGeneratorI, boolean) but with more information about the attribute to generate the Etters for. e.g. special handling for virtual and writable attributes.

marshal

public java.lang.String marshal(java.lang.Object o)

unMarshal

public java.lang.Object unMarshal(java.lang.String s)

stringToValueWithTypeTip

public java.lang.Object stringToValueWithTypeTip(java.lang.String typeName,
                                                 java.lang.String s)

getAsString

public java.lang.String getAsString(java.lang.Object o)

checkConstraints

public void checkConstraints(java.lang.Object value)
                      throws ValueSettingException

Checks the array constraints as well as optional constraints on each element

Specified by:

checkConstraints in interface CBOAttributeTypeI

Overrides:

checkConstraints in class CBOAbstractAttributeType

Throws:

ValueSettingException

getMinElements

public java.lang.Integer getMinElements()

setMinElements

public void setMinElements(java.lang.Integer $11)

getMaxElements

public java.lang.Integer getMaxElements()

setMaxElements

public void setMaxElements(java.lang.Integer $12)

getAllowNullElements

public java.lang.Boolean getAllowNullElements()

setAllowNullElements

public void setAllowNullElements(java.lang.Boolean $13)

getUseComponentsGUIText

public java.lang.Boolean getUseComponentsGUIText()

setUseComponentsGUIText

public void setUseComponentsGUIText(java.lang.Boolean $14)