de.ipcon.schema.types

Class AbstractStringType

java.lang.Object

de.ipcon.schema.types.CBOAbstractAttributeType

de.ipcon.schema.types.AbstractStringType

All Implemented Interfaces:

CBOAttributeTypeI

Direct Known Subclasses:

EmailType, PhoneNumberType, StringType

public abstract class AbstractStringType
extends CBOAbstractAttributeType

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigureInfo	CONFIG

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
AbstractStringType()
AbstractStringType(CBOAttributeTypeI base, electric.xml.Element parms)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	castToOwnType(java.lang.Object o) Tries the best to convert a value of wrong type to the own one.
void	checkConstraints(java.lang.Object value, java.lang.String typeName) 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	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).
AttributeTypeCodeGen<JavaMethodGen,JavaClassGen,AbstractStringType>	getJavaCodeGen(java.lang.String attrName)
int	getJdbcType() Type/Class that the JDBC driver returns for the column/field.
java.lang.Integer	getMaxLength()
java.lang.Integer	getMinLength()
java.lang.String	getNonNullDefaultValue()
AttributeTypeCodeGen<nrxmethod,nrxgen,AbstractStringType>	getNRXCodeGen(java.lang.String attrName)
NullDefaultType	getNullDefaultType() gives the code generator an indication on how the provided default value needs to be fit into the code, e.g.
java.util.regex.Pattern	getPattern()
java.lang.String	getSqlType() SQL column type in the relational database.
java.lang.Integer	getStandardExpectedWidth()
boolean	hasAdditionalEtters()
static void	initMustMatchPatternDescriptionsBundleLookupPath(SchemaI schema)
boolean	isMandatory()
java.lang.String	marshal(java.lang.Object o)
void	setMaxLength(java.lang.Integer $3)
void	setMinLength(java.lang.Integer $2)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str) Attempts to parse or transform the given string into a valid value (object) for this data type.
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str, boolean skipChecks) Attempts to parse or transform the given string into a valid value (object) for this data type.
java.lang.Object	unMarshal(java.lang.String s)

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

allowsValue, applyCustomExternalization, applySetBOLoaderHook, applySetHook, castToNumber, checkConstraints, compare, compareImpl, getAsString, getAsString, 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, 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

applyAdditionalEtters, applyAdditionalEtters, getAsUserFriendlyRawString, getHumanReadableIndexType, getJavaClassFQNForImport, getJavaClassnameForCode, getName

Field Detail

CONFIG

public static final ConfigureInfo CONFIG

Constructor Detail

AbstractStringType

public AbstractStringType()

AbstractStringType

public AbstractStringType(CBOAttributeTypeI base,
                          electric.xml.Element parms)

Method Detail

initMustMatchPatternDescriptionsBundleLookupPath

public static void initMustMatchPatternDescriptionsBundleLookupPath(SchemaI schema)

getPattern

public java.util.regex.Pattern getPattern()

configure

public void configure()

Specified by:

configure in interface CBOAttributeTypeI

Overrides:

configure in class CBOAbstractAttributeType

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

Attempts to parse or transform the given string into a valid value (object) for this data type.

Parameters:

str - The String value to parse or convert.

Returns:

An Object representing the parsed or converted value.

Throws:

ValueSettingException - If parsing or conversion is not possible or if type constraints are violated.

stringToValueWithTypeTip

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

Attempts to parse or transform the given string into a valid value (object) for this data type.

Parameters:

str - The String value to parse or convert.

skipChecks - A flag indicating whether to skip type constraint checks. Use with caution; typically set to true for performance reasons in specific scenarios (e.g., speed search), but consider potential consequences.

Returns:

An Object representing the parsed or converted value.

Throws:

ValueSettingException - If parsing or conversion is not possible or if type constraints are violated (unless 'skipChecks' is set to true).

castToOwnType

public java.lang.Object castToOwnType(java.lang.Object o)

Tries the best to convert a value of wrong type to the own one.

Specified by:

castToOwnType in interface CBOAttributeTypeI

Overrides:

castToOwnType in class CBOAbstractAttributeType

checkConstraints

public void checkConstraints(java.lang.Object value,
                             java.lang.String typeName)
                      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 CBOAttributeTypeI

Overrides:

checkConstraints in class CBOAbstractAttributeType

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

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface CBOAttributeTypeI

Overrides:

isMandatory in class CBOAbstractAttributeType

getJavaCodeGen

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

getNRXCodeGen

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

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

getNullDefaultType

public NullDefaultType getNullDefaultType()

Description copied from interface: CBOAttributeTypeI

gives the code generator an indication on how the provided default value needs to be fit into the code, e.g. CONSTANT = copy over as-is STRING = surround value with language-specific quotation marks

getNonNullDefaultValue

public java.lang.String getNonNullDefaultValue()

getMinLength

public java.lang.Integer getMinLength()

setMinLength

public void setMinLength(java.lang.Integer $2)

getMaxLength

public java.lang.Integer getMaxLength()

setMaxLength

public void setMaxLength(java.lang.Integer $3)