org.nuxeo.ecm.core.api.model
Interface DocumentPart

All Superinterfaces:

java.lang.Cloneable, java.lang.Iterable<Property>, Property, java.io.Serializable

All Known Implementing Classes:

DocumentPartImpl

public interface DocumentPart
extends Property

A document part is the root of a property tree which is specified by a schema

Author:

Bogdan Stefanescu

Field Summary

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

Method Summary

Property	createProperty(Property parent, Field field)
Property	createProperty(Property parent, Field field, int flags)
PropertyDiff	exportDiff()
java.util.Map<java.lang.String,java.io.Serializable>	exportValues() Exports as a map the document values.
Schema	getSchema() The document schema.
void	importDiff(PropertyDiff diff)
void	importValues(java.util.Map<java.lang.String,java.io.Serializable> values)

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

accept, addEmpty, addValue, addValue, clearDirtyFlags, convertTo, get, get, getChildren, getData, getData, getDirtyChildren, getDirtyFlags, getField, getName, getParent, getPath, getRoot, getType, getValue, getValue, getValue, getValue, getValueForWrite, init, isComplex, isContainer, isDirty, isList, isModified, isMoved, isNew, isNormalized, isPhantom, isReadOnly, isRemoved, isSameAs, isScalar, isValidating, moveTo, newInstance, normalize, remove, resolvePath, resolvePath, setData, setData, setReadOnly, setValidating, setValue, setValue, setValue, size, validate, validateType

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getSchema

Schema getSchema()

The document schema.

Specified by:

getSchema in interface Property

Returns:

the schema

createProperty

Property createProperty(Property parent,
                        Field field)

createProperty

Property createProperty(Property parent,
                        Field field,
                        int flags)

exportValues

java.util.Map<java.lang.String,java.io.Serializable> exportValues()
                                                                  throws PropertyException

Exports as a map the document values. Only the non phantom properties are exported.

Returns:

Throws:

PropertyException

importValues

void importValues(java.util.Map<java.lang.String,java.io.Serializable> values)
                  throws PropertyException

Throws:

PropertyException

exportDiff

PropertyDiff exportDiff()
                        throws PropertyException

Throws:

PropertyException

importDiff

void importDiff(PropertyDiff diff)
                throws PropertyException

Throws:

PropertyException