org.nuxeo.ecm.core.api.model.impl

Class ArrayProperty

java.lang.Object

org.nuxeo.ecm.core.api.model.impl.AbstractProperty

org.nuxeo.ecm.core.api.model.impl.ScalarProperty

org.nuxeo.ecm.core.api.model.impl.ArrayProperty

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Property>, Property

public class ArrayProperty
extends ScalarProperty

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Field Summary

Fields inherited from class org.nuxeo.ecm.core.api.model.impl.AbstractProperty

IS_READONLY, IS_VALIDATING, KEYED_DATA

Fields inherited from interface org.nuxeo.ecm.core.api.model.Property

DIRTY_MASK, IS_DIRTY, IS_MODIFIED, IS_MOVED, IS_NEW, IS_PHANTOM, IS_REMOVED, NONE

Constructor Summary

Constructors

Constructor and Description
ArrayProperty(Property parent, Field field, int flags)

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	convertTo(Serializable value, Class<T> toType) Converts the given normalized value to the given type.
ListType	getType() Get the type of the field corresponding to this property.
boolean	isContainer() Whether this property is a container - this means the property value is a map or a list.
boolean	isNormalized(Object value) Checks if the given value is a normalized one.
Object	newInstance() Creates a new and empty instance of a normalized value.
Serializable	normalize(Object value) Normalizes the given value as dictated by the property type.

Methods inherited from class org.nuxeo.ecm.core.api.model.impl.ScalarProperty

accept, addEmpty, addValue, addValue, clone, get, get, getChildren, getDirtyChildren, getField, getName, internalGetValue, internalSetValue, isSameAs, toString

Methods inherited from class org.nuxeo.ecm.core.api.model.impl.AbstractProperty

areFlagsSet, clearDirtyFlags, clearFlags, getData, getData, getDirtyFlags, getParent, getPath, getRoot, getSchema, getValue, getValue, getValue, getValue, getValueForWrite, init, isComplex, isDirty, isList, isModified, isMoved, isNew, isPhantom, isReadOnly, isRemoved, isScalar, isValidating, iterator, moveTo, remove, removePhantomFlag, resolvePath, resolvePath, setData, setData, setFlags, setIsModified, setReadOnly, setValidating, setValue, setValue, setValue, size, validate, validateType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ArrayProperty

public ArrayProperty(Property parent,
             Field field,
             int flags)

Method Detail

getType

public ListType getType()

Description copied from interface: Property

Get the type of the field corresponding to this property.

Specified by:

getType in interface Property

Overrides:

getType in class ScalarProperty

Returns:

the property type

isContainer

public boolean isContainer()

Description copied from interface: Property

Whether this property is a container - this means the property value is a map or a list.

Container properties don't have a scalar values. Container values are computed each time they are requested - by calling on of the getValue methods - by collecting the values of the child properties.

Specified by:

isContainer in interface Property

Overrides:

isContainer in class ScalarProperty

Returns:

true if scalar false otherwise

isNormalized

public boolean isNormalized(Object value)

Description copied from interface: Property

Checks if the given value is a normalized one. This means the value has a type that is normalized.

Null values are considered as normalized.

Specified by:

isNormalized in interface Property

Overrides:

isNormalized in class AbstractProperty

Parameters:

value - the value to check

Returns:

true if the value is normalized false otherwise

normalize

public Serializable normalize(Object value)
                       throws PropertyConversionException

Description copied from interface: Property

Normalizes the given value as dictated by the property type.

Normalized values are the ones that are used for transportation over the net and that are given to the storage implementation to be stored in the repository

Normalized values must be Serializable

If the given value is already normalized it will be returned back.

Specified by:

normalize in interface Property

Overrides:

normalize in class AbstractProperty

Parameters:

value - the value to normalize according to the property type

Returns:

the normalized value

Throws:

PropertyConversionException

convertTo

public <T> T convertTo(Serializable value,
              Class<T> toType)
            throws PropertyConversionException

Description copied from interface: Property

Converts the given normalized value to the given type.

If the value has already the given type it will be returned back.

Specified by:

convertTo in interface Property

Overrides:

convertTo in class AbstractProperty

Parameters:

value - the normalized value to convert

toType - the conversion type

Returns:

the converted value, which may be null

Throws:

PropertyConversionException - if the conversion cannot be made because of type incompatibilities

newInstance

public Object newInstance()

Description copied from interface: Property

Creates a new and empty instance of a normalized value.

Empty is used in the sense of a value that has not been initialized or can be considered as an empty value. For example for the String type the empty value will be the empty string ""

Specified by:

newInstance in interface Property

Overrides:

newInstance in class AbstractProperty

Returns:

the empty instance the empty instance, or null for some implementations