de.ipcon.schema.types

Class TimespanType

java.lang.Object

de.ipcon.schema.types.AbstractAttributeType

de.ipcon.schema.types.TimespanType

All Implemented Interfaces:

AttributeTypeI

public class TimespanType
extends AbstractAttributeType

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigureInfo	CONFIG
static java.lang.String	NAME
static java.lang.String	OQL_TIMESPAN_FORMAT
static java.util.Locale	OQL_TIMESPAN_LOCALE

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

OQL_NULL_STRING

Fields inherited from interface de.ipcon.schema.AttributeTypeI

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, MARSHALLED_NULL_VALUE, NO_CUSTOM_INDEX_VERSION

Constructor Summary

Constructors

Constructor and Description
TimespanType()
TimespanType(AttributeTypeI _base, electric.xml.Element _parms)

Method Summary

Modifier and Type	Method and Description
void	checkConstraints(java.lang.Object value) Checks if the given value (object) matches the constraints (limits, etc. - if any) set for this type.
void	configure()
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	getAsString(java.lang.Object obj) Converts given value (object) into a nicely formatted timespan string - if possible - and returns it.
java.lang.String	getAsString(java.lang.Object obj, java.lang.Object parento)
java.lang.String	getAsString(java.lang.Object obj, java.lang.Object parento, java.lang.String displayFormat)
java.lang.String	getAsString(java.lang.Object obj, java.lang.Object parento, java.lang.String displayFormat, java.util.Locale locale)
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	getDefaultUnit()
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.String	getFormat()
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.Long	getMaxInclusiveLimit()
java.lang.Long	getMinInclusiveLimit()
java.lang.String	getName()
java.lang.String	getNonNullDefaultValue()
java.lang.String	getNullString()
java.lang.String	getSqlType() SQL column type in the relational database.
java.lang.Integer	getStandardExpectedWidth()
boolean	hasAdditionalEtters()
boolean	isMandatory()
java.lang.String	marshal(java.lang.Object obj)
void	setDefaultUnit(java.lang.String $7)
void	setFormat(java.lang.String $3)
void	setMaxInclusiveLimit(java.lang.Long $6)
void	setMinInclusiveLimit(java.lang.Long $5)
void	setNullString(java.lang.String $4)
java.lang.Object	stringToValue(java.lang.String str) Tries to parse/transform the given string into a valid value (object) for this type.
java.lang.Object	stringToValue(java.lang.String str, java.util.Locale locale)
java.lang.Object	stringToValue(java.lang.String str, java.util.Locale locale, java.lang.String displayFormat)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str, java.util.Locale locale)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str, java.util.Locale locale, java.lang.String displayFormat)
java.lang.Object	unMarshal(java.lang.String str)

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

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

applyAdditionalEtters, applyAdditionalEtters, getAsUserFriendlyRawString, getCodeGenerator, getHumanReadableIndexType, getJavaClassFQNForImport, getJavaClassnameForClassAccessInCode, getJavaClassnameForCode, getNullDefaultType, hasCodeBuilderForScalarVirtualEtters, processAttributeTypeParameters

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

CONFIG

public static final ConfigureInfo CONFIG

OQL_TIMESPAN_FORMAT

public static final java.lang.String OQL_TIMESPAN_FORMAT

See Also:

Constant Field Values

OQL_TIMESPAN_LOCALE

public static final java.util.Locale OQL_TIMESPAN_LOCALE

Constructor Detail

TimespanType

public TimespanType()

TimespanType

public TimespanType(AttributeTypeI _base,
                    electric.xml.Element _parms)

Method Detail

getName

public java.lang.String getName()

configure

public void configure()

Specified by:

configure in interface AttributeTypeI

Overrides:

configure in class AbstractAttributeType

getJavaClass

public java.lang.Class getJavaClass()

Description copied from interface: AttributeTypeI

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: AttributeTypeI

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: AttributeTypeI

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: AttributeTypeI

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: AttributeTypeI

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

getJdbcType

public int getJdbcType()

Description copied from interface: AttributeTypeI

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 java.lang.String getExternalizePostfix()

Description copied from interface: AttributeTypeI

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

getStandardExpectedWidth

public java.lang.Integer getStandardExpectedWidth()

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface AttributeTypeI

Overrides:

isMandatory in class AbstractAttributeType

getAsString

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

Converts given value (object) into a nicely formatted timespan string - if possible - and returns it.

getAsString

public java.lang.String getAsString(java.lang.Object obj,
                                    java.lang.Object parento)

getAsString

public java.lang.String getAsString(java.lang.Object obj,
                                    java.lang.Object parento,
                                    java.lang.String displayFormat)

Specified by:

getAsString in interface AttributeTypeI

Overrides:

getAsString in class AbstractAttributeType

getAsString

public java.lang.String getAsString(java.lang.Object obj,
                                    java.lang.Object parento,
                                    java.lang.String displayFormat,
                                    java.util.Locale locale)

Specified by:

getAsString in interface AttributeTypeI

Overrides:

getAsString in class AbstractAttributeType

formatAsInlineParameter

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

Description copied from interface: AttributeTypeI

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 AttributeTypeI

Overrides:

formatAsInlineParameter in class AbstractAttributeType

marshal

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

stringToValueWithTypeTip

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

Throws:

ValueSettingException

stringToValueWithTypeTip

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

Throws:

ValueSettingException

stringToValueWithTypeTip

public java.lang.Object stringToValueWithTypeTip(java.lang.String typeName,
                                                 java.lang.String str,
                                                 java.util.Locale locale,
                                                 java.lang.String displayFormat)
                                          throws ValueSettingException

Throws:

ValueSettingException

stringToValue

public java.lang.Object stringToValue(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

Specified by:

stringToValue in interface AttributeTypeI

Overrides:

stringToValue in class AbstractAttributeType

Throws:

ValueSettingException

stringToValue

public java.lang.Object stringToValue(java.lang.String str,
                                      java.util.Locale locale)
                               throws ValueSettingException

Throws:

ValueSettingException

stringToValue

public java.lang.Object stringToValue(java.lang.String str,
                                      java.util.Locale locale,
                                      java.lang.String displayFormat)
                               throws ValueSettingException

Throws:

ValueSettingException

unMarshal

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

checkConstraints

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

Checks if the given value (object) matches the constraints (limits, etc. - if any) set for this type. Signals ValueSettingException if not.

Specified by:

checkConstraints in interface AttributeTypeI

Overrides:

checkConstraints in class AbstractAttributeType

Throws:

ValueSettingException

hasAdditionalEtters

public boolean hasAdditionalEtters()

Specified by:

hasAdditionalEtters in interface AttributeTypeI

Overrides:

hasAdditionalEtters in class AbstractAttributeType

Returns:

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

getNonNullDefaultValue

public java.lang.String getNonNullDefaultValue()

getFormat

public java.lang.String getFormat()

setFormat

public void setFormat(java.lang.String $3)

getNullString

public java.lang.String getNullString()

setNullString

public void setNullString(java.lang.String $4)

getMinInclusiveLimit

public java.lang.Long getMinInclusiveLimit()

setMinInclusiveLimit

public void setMinInclusiveLimit(java.lang.Long $5)

getMaxInclusiveLimit

public java.lang.Long getMaxInclusiveLimit()

setMaxInclusiveLimit

public void setMaxInclusiveLimit(java.lang.Long $6)

getDefaultUnit

public java.lang.String getDefaultUnit()

setDefaultUnit

public void setDefaultUnit(java.lang.String $7)