Package org.ametys.cms.data.type.impl

Class StringRepositoryElementType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.model.type.AbstractModelItemType

org.ametys.core.model.type.AbstractElementType<String>

org.ametys.core.model.type.AbstractStringElementType

org.ametys.cms.data.type.indexing.impl.StringIndexableElementType

org.ametys.cms.data.type.impl.StringRepositoryElementType

All Implemented Interfaces:

IndexableElementType<String>, IndexableModelItemType, SortableIndexableElementType<String>, RepositoryElementType<String>, RepositoryModelItemType, ElementType<String>, ModelItemType, LogEnabled, PluginAware, Component, Serviceable

Direct Known Subclasses:

PasswordRepositoryElementType

public class StringRepositoryElementType
extends StringIndexableElementType
implements RepositoryElementType<String>

Class for string type of elements stored in the repository

Field Summary

Fields inherited from class org.ametys.core.model.type.AbstractElementType

_jsonUtils

Fields inherited from interface org.ametys.plugins.repository.data.type.RepositoryModelItemType

EMPTY_METADATA_SUFFIX

Constructor Summary

Constructors

Constructor	Description
StringRepositoryElementType()

Method Summary

Modifier and Type	Method	Description
String	getRepositoryDataType()	Retrieves the type of repository data used for this type
boolean	hasNonEmptyValue(RepositoryData parentData, String name)	Check if there is a non empty value in the given repository data
Object	read(RepositoryData parentData, String name)	Read the value in the given repository data
void	write(ModifiableRepositoryData parentData, String name, Object value)	Write the value into the given repository data

Methods inherited from class org.ametys.cms.data.type.indexing.impl.StringIndexableElementType

getIndexingFieldSuffix, getSchemaType, getSortFieldSuffix, getTextFieldSuffix, getWildcardFieldSuffix, indexSingleValue, isFacetable

Methods inherited from class org.ametys.core.model.type.AbstractStringElementType

_compareSingleValues, convertValue, fromJSONForClient, isSimple, passwordValueToJSONForClient, toString

Methods inherited from class org.ametys.core.model.type.AbstractElementType

_compareMultipleValues, _getValueAttributes, _isMultiple, _isSingle, _isValueFromXMLMultiple, _singleValueFromXML, _singleValueToJSON, _singleValueToJSONForEdition, _singleValueToSAX, _useJSONForEdition, _valueToJSON, _valueToSAX, _valueToSAX, _valueToSAXForEdition, castValue, compareValues, getManagedClass, getManagedClassArray, isCompatible, parseConfiguration, service, valueFromXML, valueToJSONForClient, valueToJSONForEdition, valueToSAX, valueToSAXForEdition

Methods inherited from class org.ametys.core.model.type.AbstractModelItemType

getId, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.runtime.model.type.ElementType

castValue, compareValues, fromJSONForClient, getManagedClass, getManagedClassArray, isCompatible, isSimple, parseConfiguration, toString, valueFromXML

Methods inherited from interface org.ametys.cms.data.type.indexing.IndexableElementType

getSingleValueToIndex

Methods inherited from interface org.ametys.runtime.model.type.ModelItemType

getId, valueToJSONForClient, valueToJSONForClient, valueToJSONForEdition, valueToSAX, valueToSAX, valueToSAXForEdition

Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware

setPluginInfo

Methods inherited from interface org.ametys.plugins.repository.data.type.RepositoryElementType

externalizableValueToJSON

Methods inherited from interface org.ametys.plugins.repository.data.type.RepositoryModelItemType

hasValue, isCompatible, isMultiple, remove

Methods inherited from interface org.ametys.cms.data.type.indexing.SortableIndexableElementType

getSingleSortValueToIndex, indexSingleSortValue, indexValue

Constructor Details

StringRepositoryElementType

public StringRepositoryElementType()

Method Details

read

public Object read(RepositoryData parentData,
 String name)
            throws BadItemTypeException

Description copied from interface: RepositoryElementType

Read the value in the given repository data

Specified by:

read in interface RepositoryElementType<String>

Parameters:

parentData - repository data containing the value

name - the name of the element to read

Returns:

the value. Can return a T or a T[]. That's why the return type is Object

Throws:

BadItemTypeException - if the reading value doesn't match this element type

hasNonEmptyValue

public boolean hasNonEmptyValue(RepositoryData parentData,
 String name)
                         throws BadItemTypeException

Description copied from interface: RepositoryModelItemType

Check if there is a non empty value in the given repository data

Specified by:

hasNonEmptyValue in interface RepositoryModelItemType

Parameters:

parentData - repository data containing the value

name - the name of the element to check

Returns:

true if there is a non empty value, false otherwise

Throws:

BadItemTypeException - if the reading value doesn't match this element type

write

public void write(ModifiableRepositoryData parentData,
 String name,
 Object value)
           throws BadItemTypeException

Description copied from interface: RepositoryElementType

Write the value into the given repository data

Specified by:

write in interface RepositoryElementType<String>

Parameters:

parentData - repository where to store the value.

name - the name of the element to write

value - the value to write. Can be a T or a T[]. That's why it is an Object

Throws:

BadItemTypeException - If the given value doesn't match this element type

getRepositoryDataType

public String getRepositoryDataType()

Description copied from interface: RepositoryModelItemType

Retrieves the type of repository data used for this type

Specified by:

getRepositoryDataType in interface RepositoryModelItemType

Returns:

the type of repository data used for this type