de.ipcon.schema

Interface CBOAttributeTypeI

All Known Implementing Classes:

AbstractStringType, BooleanType, CBOAbstractAttributeType, DatetimeType, DecimalType, DoubleType, DurationType, EmailType, FloatType, IntegerType, LongType, NumberType, PasswordType, PhoneNumberType, StringType, TimespanType, URIType, WrappingArrayType, XMLType

public interface CBOAttributeTypeI

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEX_TYPE_AUTO
static int	INDEX_TYPE_BRIN
static int	INDEX_TYPE_BRIN_FB_BTREE
static int	INDEX_TYPE_BTREE
static int	INDEX_TYPE_CUSTOM
static int	INDEX_TYPE_GIN
static int	INDEX_TYPE_GIN_FB_BTREE
static int	INDEX_TYPE_NONE
static int	INDEX_TYPE_TRIGRAM
static java.util.Map<java.lang.String,java.lang.Integer>	INDEX_TYPES
static java.lang.String[]	INDEX_TYPES_HR
static int	NO_CUSTOM_INDEX_VERSION

Method Summary

Modifier and Type	Method and Description
boolean	allowsValue(java.lang.Object value)
default void	applyAdditionalEtters(CBOAttributeI attr, SourceGeneratorI src) Same as 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.
default <C extends SourceGeneratorI> void	applyAdditionalEtters(java.lang.String attrName, C src, boolean getterOnly) Uses a source generator to generate additional setter and getter methods into the source code for an attribute.
void	applyCustomExternalization(java.lang.String vn, MethodGeneratorI exreadmeth, MethodGeneratorI exwritemeth, java.lang.String indentWrite)
void	applySetBOLoaderHook(java.lang.String vn, MethodGeneratorI setbolmeth)
boolean	applySetHook(java.lang.String vn, MethodGeneratorI setmeth)
java.lang.Object	castToOwnType(java.lang.Object o)
void	checkConstraints(java.lang.Object value)
void	checkConstraints(java.lang.Object value, java.lang.String typeName)
int	compare(java.lang.Object o1, java.lang.Object o2)
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	getAsString(java.lang.Object o, java.lang.Object parento, java.lang.String displayFormat)
java.lang.String	getAsString(java.lang.Object o, java.lang.Object parento, java.lang.String displayFormat, java.util.Locale locale)
java.lang.String	getAsString(java.lang.Object o, java.lang.Object parento, java.lang.String displayFormat, java.util.Locale locale, java.util.TimeZone timeZone)
default java.lang.String	getAsUserFriendlyRawString(java.lang.Object o)
CBOAttributeTypeI	getBase()
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.
java.lang.String	getComponentSqlType() If this is a getCastorCollectionType() with an explicit component type, then returns the SQL column type the component.
java.lang.String	getDAUType() User-friendly l10n-ed name for the type, to be used for user interaction.
java.lang.String	getDef()
electric.xml.Element	getDefinition()
java.lang.Integer	getExpectedWidth()
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).
javax.swing.text.DocumentFilter	getFilter(java.util.ArrayList inputFormats)
static java.lang.String	getHumanReadableIndexType(int type)
int	getIndexType()
java.lang.Class<?>	getJavaClass() The not null type/Class of the field in the Java object (the MyTISM BO).
default java.lang.String	getJavaClassFQNForImport() Return the fully qualified java class name in an import [result] compatible for.
default java.lang.String	getJavaClassnameForCode() Return the java class name as used in fields declarations with this class.
default AttributeTypeCodeGen<JavaMethodGen,JavaClassGen,?>	getJavaCodeGen(java.lang.String attrName)
int	getJdbcType() Type/Class that the JDBC driver returns for the column/field.
java.lang.String	getName()
default java.lang.String	getNonNullDefaultValue()
default AttributeTypeCodeGen<nrxmethod,nrxgen,?>	getNRXCodeGen(java.lang.String attrName)
default NullDefaultType	getNullDefaultType() gives the code generator an indication on how the provided default value needs to be fit into the code, e.g.
java.lang.String	getSqlType() SQL column type in the relational database.
java.lang.Integer	getStandardExpectedWidth()
java.lang.Boolean	getUnique()
boolean	hasAdditionalEtters()
boolean	hasCustomExternalization()
boolean	hasSetBOLoaderHook()
boolean	hasSetHook()
boolean	isCore()
boolean	isIndexed()
boolean	isMandatory()
java.lang.String	marshal(java.lang.Object o)
java.lang.String	marshal(java.lang.Object o, CryptoHandlerI c)
java.lang.Object	setAsString(java.lang.String s)
java.lang.Object	setAsString(java.lang.String s, boolean checkConstraints)
java.lang.Object	setAsString(java.lang.String s, boolean checkConstraints, java.lang.String typeName)
java.lang.Object	stringToValue(java.lang.String str)
java.lang.Object	stringToValue(java.lang.String str, java.lang.Object parento)
java.lang.Object	stringToValue(java.lang.String str, java.lang.Object parento, java.lang.String displayFormat)
java.lang.Object	stringToValue(java.lang.String str, java.lang.Object parento, java.lang.String displayFormat, java.util.Locale locale)
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.lang.Object parento)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str, java.lang.Object parento, java.lang.String displayFormat)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str, java.lang.Object parento, java.lang.String displayFormat, java.util.Locale locale)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String str, java.lang.Object parento, java.lang.String displayFormat, java.util.Locale locale, java.util.TimeZone timeZone)
void	toXML(electric.xml.Element element, java.lang.String name, java.lang.Object value)
java.lang.String	toXMLString(java.lang.String name, java.lang.String value)
java.lang.Object	unMarshal(java.lang.String s)

Field Detail

NO_CUSTOM_INDEX_VERSION

static final int NO_CUSTOM_INDEX_VERSION

See Also:

Constant Field Values

INDEX_TYPE_AUTO

static final int INDEX_TYPE_AUTO

See Also:

Constant Field Values

INDEX_TYPE_NONE

static final int INDEX_TYPE_NONE

See Also:

Constant Field Values

INDEX_TYPE_BTREE

static final int INDEX_TYPE_BTREE

See Also:

Constant Field Values

INDEX_TYPE_TRIGRAM

static final int INDEX_TYPE_TRIGRAM

See Also:

Constant Field Values

INDEX_TYPE_BRIN

static final int INDEX_TYPE_BRIN

See Also:

Constant Field Values

INDEX_TYPE_BRIN_FB_BTREE

static final int INDEX_TYPE_BRIN_FB_BTREE

See Also:

Constant Field Values

INDEX_TYPE_GIN

static final int INDEX_TYPE_GIN

See Also:

Constant Field Values

INDEX_TYPE_GIN_FB_BTREE

static final int INDEX_TYPE_GIN_FB_BTREE

See Also:

Constant Field Values

INDEX_TYPE_CUSTOM

static final int INDEX_TYPE_CUSTOM

See Also:

Constant Field Values

INDEX_TYPES

static final java.util.Map<java.lang.String,java.lang.Integer> INDEX_TYPES

INDEX_TYPES_HR

static final java.lang.String[] INDEX_TYPES_HR

Method Detail

getHumanReadableIndexType

static java.lang.String getHumanReadableIndexType(int type)

marshal

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

marshal

java.lang.String marshal(java.lang.Object o,
                         CryptoHandlerI c)

unMarshal

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

getAsString

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

getAsString

java.lang.String getAsString(java.lang.Object o,
                             java.lang.Object parento,
                             java.lang.String displayFormat)

getAsString

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

getAsString

java.lang.String getAsString(java.lang.Object o,
                             java.lang.Object parento,
                             java.lang.String displayFormat,
                             java.util.Locale locale,
                             java.util.TimeZone timeZone)

getAsUserFriendlyRawString

default java.lang.String getAsUserFriendlyRawString(java.lang.Object o)

formatAsInlineParameter

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. Single quotes are escaped to prevent prematurely ending the query-String.

formatAsInlineParameter

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. Given queryQuotationMarks are escaped to prevent prematurely ending the query-String.

stringToValue

java.lang.Object stringToValue(java.lang.String str)
                        throws ValueSettingException

Throws:

ValueSettingException

stringToValue

java.lang.Object stringToValue(java.lang.String str,
                               java.lang.Object parento)
                        throws ValueSettingException

Throws:

ValueSettingException

stringToValue

java.lang.Object stringToValue(java.lang.String str,
                               java.lang.Object parento,
                               java.lang.String displayFormat)
                        throws ValueSettingException

Throws:

ValueSettingException

stringToValue

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

Throws:

ValueSettingException

stringToValueWithTypeTip

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

Throws:

ValueSettingException

stringToValueWithTypeTip

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

Throws:

ValueSettingException

stringToValueWithTypeTip

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

Throws:

ValueSettingException

stringToValueWithTypeTip

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

Throws:

ValueSettingException

stringToValueWithTypeTip

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

Throws:

ValueSettingException

checkConstraints

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

Throws:

ValueSettingException

checkConstraints

void checkConstraints(java.lang.Object value,
                      java.lang.String typeName)
               throws ValueSettingException

Throws:

ValueSettingException

allowsValue

boolean allowsValue(java.lang.Object value)

setAsString

java.lang.Object setAsString(java.lang.String s)

setAsString

java.lang.Object setAsString(java.lang.String s,
                             boolean checkConstraints)

setAsString

java.lang.Object setAsString(java.lang.String s,
                             boolean checkConstraints,
                             java.lang.String typeName)

castToOwnType

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

getJavaClass

java.lang.Class<?> getJavaClass()

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

getJavaClassFQNForImport

default java.lang.String getJavaClassFQNForImport()

Return the fully qualified java class name in an import [result] compatible for. For automatic generated code.

Returns:

the nonnull and not empty fqn of the java class

getJavaClassnameForCode

default java.lang.String getJavaClassnameForCode()

Return the java class name as used in fields declarations with this class. For automatic generated code. i.e. java.lang.String[] instead of [Ljava.lang.String;

Returns:

the nonnull and not empty name of the java class

getCastorFieldType

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

java.lang.String getCastorSqlType()

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

getCastorCollectionType

java.lang.String getCastorCollectionType()

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

getSqlType

java.lang.String getSqlType()

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

getComponentSqlType

java.lang.String getComponentSqlType()

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

getDAUType

java.lang.String getDAUType()

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

getJdbcType

int getJdbcType()

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

getExpectedWidth

java.lang.Integer getExpectedWidth()

getStandardExpectedWidth

java.lang.Integer getStandardExpectedWidth()

getDef

java.lang.String getDef()

getExternalizePostfix

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

getName

java.lang.String getName()

toXMLString

java.lang.String toXMLString(java.lang.String name,
                             java.lang.String value)

toXML

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

compare

int compare(java.lang.Object o1,
            java.lang.Object o2)

isMandatory

boolean isMandatory()

getFilter

javax.swing.text.DocumentFilter getFilter(java.util.ArrayList inputFormats)

getIndexType

int getIndexType()

isIndexed

boolean isIndexed()

getUnique

java.lang.Boolean getUnique()

configure

void configure()

isCore

boolean isCore()

getDefinition

electric.xml.Element getDefinition()

getBase

CBOAttributeTypeI getBase()

getJavaCodeGen

default AttributeTypeCodeGen<JavaMethodGen,JavaClassGen,?> getJavaCodeGen(java.lang.String attrName)

getNRXCodeGen

default AttributeTypeCodeGen<nrxmethod,nrxgen,?> getNRXCodeGen(java.lang.String attrName)

getNullDefaultType

default NullDefaultType getNullDefaultType()

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

default java.lang.String getNonNullDefaultValue()

hasCustomExternalization

boolean hasCustomExternalization()

applyCustomExternalization

void applyCustomExternalization(java.lang.String vn,
                                MethodGeneratorI exreadmeth,
                                MethodGeneratorI exwritemeth,
                                java.lang.String indentWrite)

hasSetBOLoaderHook

boolean hasSetBOLoaderHook()

applySetBOLoaderHook

void applySetBOLoaderHook(java.lang.String vn,
                          MethodGeneratorI setbolmeth)

hasSetHook

boolean hasSetHook()

applySetHook

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

hasAdditionalEtters

boolean hasAdditionalEtters()

Returns:

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

applyAdditionalEtters

default <C extends SourceGeneratorI> void applyAdditionalEtters(java.lang.String attrName,
                                                                C src,
                                                                boolean getterOnly)

Uses a source generator to generate additional setter and getter methods into the source code for an attribute. Is only called if hasAdditionalEtters() returns true. Can be used to generate NN- or special access methods.

Parameters:

attrName - 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

default void applyAdditionalEtters(CBOAttributeI attr,
                                   SourceGeneratorI src)

Same as 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.