de.ipcon.schema.types

Class StringMapType

java.lang.Object

de.ipcon.schema.types.AbstractAttributeType

de.ipcon.schema.types.StringMapType

All Implemented Interfaces:

AttributeTypeI

Direct Known Subclasses:

L10nStringType

public class StringMapType
extends AbstractAttributeType

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigureInfo	CONFIG
static java.lang.String	MAP_STRING_STRING
static java.lang.String	NAME

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

Method Summary

Modifier and Type	Method and Description
void	applyAdditionalEtters(CBOAttributeI attr, SourceGeneratorI src) Same as AttributeTypeI.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.
boolean	applySetHook(java.lang.String attrName, MethodGeneratorI setter)
void	checkConstraints(java.lang.Object valueToCheck) Checks if the given value (object) matches the constraints (limits, etc. - if any) set for this type.
void	configure()
static java.util.Map<java.lang.String,java.lang.String>	fromString(java.lang.String s) Deserializes the string back into a Map.
java.lang.Boolean	getAllowNullEntries()
java.lang.Boolean	getAllowNullKeys()
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.
AttributeTypeCodeGen<JavaMethodGen,JavaClassGen,StringMapType>	getCodeGenerator(java.lang.String attrName)
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).
java.lang.String	getJavaClassnameForClassAccessInCode() Return the java class name as used in situations where we need to access the class.
java.lang.String	getJavaClassnameForCode() Return the java class name as used in fields declarations with this class.
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	hasAdditionalEtters()
boolean	hasCodeBuilderForScalarVirtualEtters()
boolean	hasSetHook()
java.lang.String	marshal(java.lang.Object o) Converts a Java Map into the PostgreSQL hstore string representation.
void	setAllowNullEntries(java.lang.Boolean allowNullEntries)
void	setAllowNullKeys(java.lang.Boolean allowNullKeys)
java.lang.Object	stringToValueWithTypeTip(java.lang.String typeName, java.lang.String s)
java.lang.Object	unMarshal(java.lang.String s) Parses a PostgreSQL hstore string back into a Java Map.

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

allowsValue, applyCustomExternalization, applySetBOLoaderHook, castToNumber, castToOwnType, checkConstraints, compare, compareImpl, formatAsInlineParameter, formatAsInlineParameter, getAsString, getAsString, getAsString, getBase, getBool, getCastorCollectionType, getCastorJavaClass, getComponentSqlType, 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.AttributeTypeI

applyAdditionalEtters, getAsUserFriendlyRawString, getHumanReadableIndexType, getJavaClassFQNForImport, getNonNullDefaultValue, getNullDefaultType, processAttributeTypeParameters

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

CONFIG

public static final ConfigureInfo CONFIG

MAP_STRING_STRING

public static final java.lang.String MAP_STRING_STRING

See Also:

Constant Field Values

Constructor Detail

StringMapType

public StringMapType()

StringMapType

public StringMapType(electric.xml.Element parms)

StringMapType

public StringMapType(AttributeTypeI base,
                     electric.xml.Element parms)

Method Detail

configure

public void configure()

Specified by:

configure in interface AttributeTypeI

Overrides:

configure in class AbstractAttributeType

getName

public java.lang.String getName()

getAllowNullKeys

public java.lang.Boolean getAllowNullKeys()

setAllowNullKeys

public void setAllowNullKeys(java.lang.Boolean allowNullKeys)

getAllowNullEntries

public java.lang.Boolean getAllowNullEntries()

setAllowNullEntries

public void setAllowNullEntries(java.lang.Boolean allowNullEntries)

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

getJavaClassnameForCode

public java.lang.String getJavaClassnameForCode()

Description copied from interface: AttributeTypeI

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

getJavaClassnameForClassAccessInCode

public java.lang.String getJavaClassnameForClassAccessInCode()

Description copied from interface: AttributeTypeI

Return the java class name as used in situations where we need to access the 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 for class access

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

getStandardExpectedWidth

public java.lang.Integer getStandardExpectedWidth()

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

getAsString

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

stringToValueWithTypeTip

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

Throws:

ValueSettingException

checkConstraints

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

Description copied from interface: AttributeTypeI

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

getCodeGenerator

public AttributeTypeCodeGen<JavaMethodGen,JavaClassGen,StringMapType> getCodeGenerator(java.lang.String attrName)

hasSetHook

public boolean hasSetHook()

Specified by:

hasSetHook in interface AttributeTypeI

Overrides:

hasSetHook in class AbstractAttributeType

applySetHook

public boolean applySetHook(java.lang.String attrName,
                            MethodGeneratorI setter)

Specified by:

applySetHook in interface AttributeTypeI

Overrides:

applySetHook in class AbstractAttributeType

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

hasCodeBuilderForScalarVirtualEtters

public boolean hasCodeBuilderForScalarVirtualEtters()

applyAdditionalEtters

public void applyAdditionalEtters(CBOAttributeI attr,
                                  SourceGeneratorI src)

Description copied from interface: AttributeTypeI

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

Converts a Java Map into the PostgreSQL hstore string representation.

Syntax: "key1"=>"val1", "key2"=>"val2"

Parameters:

o - Must be an instance of java.util.Map

Returns:

The hstore formatted string or the internal NULL token for a null value.

Throws:

MarshallingException - if the passed non-null object is not a Map.

unMarshal

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

Parses a PostgreSQL hstore string back into a Java Map.

Parameters:

s - The raw string from the database or the internal NULL token.

Returns:

A Map or null if the input was null or the NULL token.

fromString

public static java.util.Map<java.lang.String,java.lang.String> fromString(java.lang.String s)

Deserializes the string back into a Map.