de.ipcon.schema.types

Class XMLType

java.lang.Object

de.ipcon.schema.types.CBOAbstractAttributeType

de.ipcon.schema.types.XMLType

All Implemented Interfaces:

CBOAttributeTypeI

public class XMLType
extends CBOAbstractAttributeType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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

CONFIG, 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
XMLType()
XMLType(CBOAttributeTypeI _base, electric.xml.Element _parms)

Method Summary

Modifier and Type	Method and Description
int	compareImpl(java.lang.Object o1, java.lang.Object o2)
java.lang.String	formatAsInlineParameter(java.lang.String s) Converts the passed String s to a String representation our OQL-query-engine can use in the query.
java.lang.String	formatAsInlineParameter(java.lang.String s, java.lang.String queryQuotationMark) Converts the passed String s to a String representation our OQL-query-engine can use in the query.
java.lang.String	getAsString(java.lang.Object o)
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.
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).
int	getJdbcType() Type/Class that the JDBC driver returns for the column/field.
java.lang.String	getName()
java.lang.String	getSqlType() SQL column type in the relational database.
java.lang.Integer	getStandardExpectedWidth()
boolean	isMandatory()
java.lang.String	marshal(java.lang.Object o)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str) Tries to parse/transform the given string into a valid value (object) for this type.
void	toXML(electric.xml.Element element, java.lang.String name, java.lang.Object value)
java.lang.Object	unMarshal(java.lang.String s)

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

allowsValue, applyCustomExternalization, applySetBOLoaderHook, applySetHook, castToNumber, castToOwnType, checkConstraints, checkConstraints, compare, configure, getAsString, getAsString, getAsString, getBase, getBool, getCastorCollectionType, getCastorJavaClass, getComponentSqlType, getDef, getDefinition, getExpectedWidth, getFilter, getFloat, getIndexType, getInt, getLong, getNullable, getPositiveInt, getUnique, hasAdditionalEtters, hasCustomExternalization, hasSetBOLoaderHook, hasSetHook, isCore, isIndexed, marshal, nullable, setAsString, setAsString, setAsString, setBase, setDef, setExpectedWidth, setIndexType, setNullable, setUnique, stringToValue, stringToValue, stringToValue, stringToValue, stringToValueWithTypeTip, stringToValueWithTypeTip, stringToValueWithTypeTip, stringToValueWithTypeTip, 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

applyAdditionalEtters, applyAdditionalEtters, getAsUserFriendlyRawString, getHumanReadableIndexType, getJavaClassFQNForImport, getJavaClassnameForCode, getJavaCodeGen, getNonNullDefaultValue, getNRXCodeGen, getNullDefaultType

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

XMLType

public XMLType()

XMLType

public XMLType(CBOAttributeTypeI _base,
               electric.xml.Element _parms)

Method Detail

getName

public java.lang.String getName()

getAsString

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

Throws:

java.lang.IllegalArgumentException

formatAsInlineParameter

public java.lang.String formatAsInlineParameter(java.lang.String s)

Description copied from interface: CBOAttributeTypeI

Converts the passed String s to a String representation our OQL-query-engine can use in the query. Single quotes are escaped to prevent prematurely ending the query-String.

Specified by:

formatAsInlineParameter in interface CBOAttributeTypeI

Overrides:

formatAsInlineParameter in class CBOAbstractAttributeType

formatAsInlineParameter

public java.lang.String formatAsInlineParameter(java.lang.String s,
                                                java.lang.String queryQuotationMark)

Description copied from interface: CBOAttributeTypeI

Converts the passed String s to a String representation our OQL-query-engine can use in the query. Given queryQuotationMarks are escaped to prevent prematurely ending the query-String.

Specified by:

formatAsInlineParameter in interface CBOAttributeTypeI

Overrides:

formatAsInlineParameter in class CBOAbstractAttributeType

stringToValueWithTypeTip

public java.lang.Object stringToValueWithTypeTip(java.lang.String typeName,
                                                 java.lang.String str)
                                          throws ValueSettingException

Tries to parse/transform the given string into a valid value (object) for this type. Signals ValueSettingException if this is not possible

Throws:

ValueSettingException

marshal

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

unMarshal

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

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).

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 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().

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.

getJdbcType

public 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.).

getStandardExpectedWidth

public java.lang.Integer getStandardExpectedWidth()

getExternalizePostfix

public 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).

toXML

public void toXML(electric.xml.Element element,
                  java.lang.String name,
                  java.lang.Object value)

Specified by:

toXML in interface CBOAttributeTypeI

Overrides:

toXML in class CBOAbstractAttributeType

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface CBOAttributeTypeI

Overrides:

isMandatory in class CBOAbstractAttributeType

compareImpl

public int compareImpl(java.lang.Object o1,
                       java.lang.Object o2)

Overrides:

compareImpl in class CBOAbstractAttributeType