DBSDocument (Nuxeo ECM Projects 10.10 API)

java.lang.Object
- org.nuxeo.ecm.core.storage.BaseDocument<State>
- - org.nuxeo.ecm.core.storage.dbs.DBSDocument

All Implemented Interfaces:

Document
```
public class DBSDocument
extends BaseDocument<State>
```
Implementation of a Document for Document-Based Storage. The document is stored as a JSON-like Map. The keys of the Map are the property names (including special names for system properties), and the values Map are Serializable values, either:
- a scalar (String, Long, Double, Boolean, Calendar, Binary),
- an array of scalars,
- a List of Maps, recursively,
- or another Map, recursively.
An ACP value is stored as a list of maps. Each map has a keys for the ACL name and the actual ACL which is a list of ACEs. An ACE is a map having as keys username, permission, and grant.
Since:

5.9.4

Nested Class Summary
- Nested classes/interfaces inherited from class org.nuxeo.ecm.core.storage.BaseDocument
  BaseDocument.BlobWriteContext<T extends StateAccessor>, BaseDocument.BlobWriteInfo<T extends StateAccessor>, BaseDocument.StateBlobAccessor, BaseDocument.Visit
- Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.model.Document
  Document.BlobAccessor, Document.WriteContext

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APPLICATION_OCTET_STREAM`
`static String`	`CHANGE_TOKEN_PROXY_SEP`
`protected DBSDocumentState`	`docState`
`static String`	`FACETED_TAG`
`static String`	`FACETED_TAG_LABEL`
`protected String`	`id`
`static Long`	`INITIAL_CHANGE_TOKEN`
`static Long`	`INITIAL_SYS_CHANGE_TOKEN`
`static String`	`KEY_ACE_BEGIN`
`static String`	`KEY_ACE_CREATOR`
`static String`	`KEY_ACE_END`
`static String`	`KEY_ACE_GRANT`
`static String`	`KEY_ACE_PERMISSION`
`static String`	`KEY_ACE_STATUS`
`static String`	`KEY_ACE_USER`
`static String`	`KEY_ACL`
`static String`	`KEY_ACL_NAME`
`static String`	`KEY_ACP`
`static String`	`KEY_ANCESTOR_IDS`
`static String`	`KEY_BASE_VERSION_ID`
`static String`	`KEY_BLOB_DATA`
`static String`	`KEY_BLOB_DIGEST`
`static String`	`KEY_BLOB_ENCODING`
`static String`	`KEY_BLOB_LENGTH`
`static String`	`KEY_BLOB_MIME_TYPE`
`static String`	`KEY_BLOB_NAME`
`static String`	`KEY_CHANGE_TOKEN`
`static String`	`KEY_DC_MODIFIED`
`static String`	`KEY_FULLTEXT_BINARY`
`static String`	`KEY_FULLTEXT_JOBID`
`static String`	`KEY_FULLTEXT_SCORE`
`static String`	`KEY_FULLTEXT_SIMPLE`
`static String`	`KEY_ID`
`static String`	`KEY_IS_CHECKED_IN`
`static String`	`KEY_IS_LATEST_MAJOR_VERSION`
`static String`	`KEY_IS_LATEST_VERSION`
`static String`	`KEY_IS_PROXY`
`static String`	`KEY_IS_RETENTION_ACTIVE`
`static String`	`KEY_IS_TRASHED`
`static String`	`KEY_IS_VERSION`
`static String`	`KEY_LIFECYCLE_POLICY`
`static String`	`KEY_LIFECYCLE_STATE`
`static String`	`KEY_LOCK_CREATED`
`static String`	`KEY_LOCK_OWNER`
`static String`	`KEY_MAJOR_VERSION`
`static String`	`KEY_MINOR_VERSION`
`static String`	`KEY_MIXIN_TYPES`
`static String`	`KEY_NAME`
`static String`	`KEY_PARENT_ID`
`static String`	`KEY_PATH_INTERNAL`
`static String`	`KEY_POS`
`static String`	`KEY_PREFIX`
`static String`	`KEY_PRIMARY_TYPE`
`static String`	`KEY_PROXY_IDS`
`static String`	`KEY_PROXY_TARGET_ID`
`static String`	`KEY_PROXY_VERSION_SERIES_ID`
`static String`	`KEY_READ_ACL`
`static String`	`KEY_SYS_CHANGE_TOKEN`
`static String`	`KEY_VERSION_CREATED`
`static String`	`KEY_VERSION_DESCRIPTION`
`static String`	`KEY_VERSION_LABEL`
`static String`	`KEY_VERSION_SERIES_ID`
`static String`	`PROP_MAJOR_VERSION`
`static String`	`PROP_MINOR_VERSION`
`static String`	`PROP_UID_MAJOR_VERSION`
`static String`	`PROP_UID_MINOR_VERSION`
`protected List<Schema>`	`proxySchemas`
`protected boolean`	`readonly`
`protected DBSSession`	`session`
`static String`	`SYSPROP_FULLTEXT_BINARY`
`static String`	`SYSPROP_FULLTEXT_JOBID`
`static String`	`SYSPROP_FULLTEXT_SIMPLE`
`static String`	`SYSPROP_IS_TRASHED`
`protected static Map<String,String>`	`systemPropNameMap`
`protected DocumentType`	`type`

Fields inherited from class org.nuxeo.ecm.core.storage.BaseDocument
BLOB_DATA, BLOB_DIGEST, BLOB_ENCODING, BLOB_LENGTH, BLOB_MIME_TYPE, BLOB_NAME, DC_ISSUED, DC_MODIFIED, DC_PREFIX, EMPTY_STRING_ARRAY, FULLTEXT_BINARYTEXT_PROP, FULLTEXT_JOBID_PROP, FULLTEXT_SIMPLETEXT_PROP, IS_TRASHED_PROP, LOCK_CREATED_PROP, LOCK_OWNER_PROP, MISC_LIFECYCLE_STATE_PROP, NO_DIRTY, NON_CANONICAL_INDEX, RELATED_TEXT, RELATED_TEXT_ID, RELATED_TEXT_RESOURCES, TOKEN_SEP, VERSION_WRITABLE_PROPS

Constructor Summary

Constructors
Constructor and Description

DBSDocument(DBSDocumentState docState, DocumentType type, DBSSession session, boolean readonly)

Constructors
Constructor and Description
`DBSDocument(DBSDocumentState docState, DocumentType type, DBSSession session, boolean readonly)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Document`	`addChild(String name, String typeName)` Creates a new child document of the given type.
`boolean`	`addFacet(String facet)` Adds a facet to this document.
`Document`	`checkIn(String label, String checkinComment)` Creates a new version.
`void`	`checkOut()`
`boolean`	`equals(Object other)`
`void`	`followTransition(String transition)` Follows a given life cycle transition.
`Set<String>`	`getAllFacets()` Gets the facets available on this document (from the type and the instance facets).
`Collection<String>`	`getAllowedStateTransitions()` Returns the allowed state transitions for this document.
`Document`	`getBaseVersion()` Gets the version to which a checked in document is linked.
`String`	`getChangeToken()` Gets the current change token for this document.
`String`	`getCheckinComment()` Gets the version check in comment of this document if it's a version or a proxy.
`protected State`	`getChild(State state, String name, Type type)` Gets a child state.
`Document`	`getChild(String name)` Gets a child document given its name.
`protected List<State>`	`getChildAsList(State state, String name)` Gets a child state which is a list.
`protected State`	`getChildForWrite(State state, String name, Type type)` Gets a child state into which we will want to write data.
`List<Document>`	`getChildren()` Gets the children of the document.
`List<String>`	`getChildrenIds()` Gets a list of the children ids.
`protected Lock`	`getDocumentLock()` Gets the lock from this recently created and unsaved document.
`String[]`	`getFacets()` Gets the facets defined on this document instance.
`Document`	`getLastVersion()` Gets the last version of this document.
`String`	`getLifeCyclePolicy()` Gets the life cycle policy of this document.
`String`	`getLifeCycleState()` Gets the life cycle state of this document.
`String`	`getName()` Gets the name of this document.
`Document`	`getParent()` Gets the parent document, or `null` if this is the root document.
`String`	`getPath()` Gets the path of this document.
`Long`	`getPos()` Gets the document's position in its containing folder (if ordered).
`Serializable`	`getPropertyValue(String name)` Gets a simple property value.
`protected List<Schema>`	`getProxySchemas()` Gets the list of proxy schemas, if this is a proxy.
`protected static String`	`getProxyUserVisibleChangeToken(String proxyToken, String targetToken)`
`String`	`getRepositoryName()` Gets the repository in which the document lives.
`protected String`	`getSchema(String xpath)`
`protected static Set<String>`	`getSchemas(DocumentType type, List<Object> facets)`
`Session`	`getSession()` Gets the session that owns this document.
`Document`	`getSourceDocument()` Gets the source for this document.
`protected DBSDocumentState`	`getStateOrTarget()` Gets the target state if this is a proxy, or the regular state otherwise.
`protected DBSDocumentState`	`getStateOrTarget(String xpath)`
`protected DBSDocumentState`	`getStateOrTarget(Type type)`
`protected DBSDocumentState`	`getStateOrTargetForSchema(String schema)` Checks if the given schema should be resolved on the proxy or the target.
`<T extends Serializable> T`	`getSystemProp(String name, Class<T> type)` Gets a system property.
`DBSDocument`	`getTargetDocument()` Gets the document (version or live document) to which this proxy points.
`protected String`	`getTargetDocumentId()`
`DocumentType`	`getType()` Gets the type of this document.
`String`	`getUUID()` Gets this document's UUID.
`Object`	`getValue(String xpath)` Gets a property value.
`Document`	`getVersion(String label)` Gets a version of this document, given its label.
`Calendar`	`getVersionCreationDate()` Gets the version creation date of this document if it's a version or a proxy.
`String`	`getVersionLabel()` Gets the version label.
`List<Document>`	`getVersions()` Gets the versions for this document.
`String`	`getVersionSeriesId()` Gets the version series id.
`List<String>`	`getVersionsIds()` Gets the list of version ids for this document.
`Document`	`getWorkingCopy()` Gets the working copy for this document.
`boolean`	`hasChild(String name)` Checks whether this document has a child of the given name.
`boolean`	`hasChildren()` Tests if the document has any children.
`boolean`	`hasFacet(String facet)` Checks whether this document has a given facet, either from its type or added on the instance.
`int`	`hashCode()`
`protected String`	`internalName(String name)` Finds the internal name to use to refer to this property.
`boolean`	`isCheckedOut()` Checks whether this document is checked out.
`protected boolean`	`isEqualOnVersion(Object ob, String key)`
`boolean`	`isFolder()` Checks whether this document is a folder.
`boolean`	`isLatestMajorVersion()` Checks whether this document is the latest major version.
`boolean`	`isLatestVersion()` Checks whether this document is the latest version.
`boolean`	`isMajorVersion()` Checks whether this document is a major version.
`boolean`	`isProxy()` Checks whether or not this document is a proxy.
`boolean`	`isReadOnly()` Checks whether this document is readonly or not.
`boolean`	`isRetentionActive()` Checks whether this document is under active retention.
`protected boolean`	`isSchemaForProxy(String schema)`
`boolean`	`isVersion()` Checks whether this document is a version document.
`boolean`	`isVersionSeriesCheckedOut()` Checks if there is a checked out working copy for the version series of this document.
`void`	`markUserChange()` Marks the document as being modified by a user change.
`void`	`orderBefore(String src, String dest)` Orders the given source child before the destination child.
`void`	`readDocumentPart(DocumentPart dp)` Loads a `DocumentPart` from storage.
`void`	`remove()` Removes this document and all its children, if any.
`protected Lock`	`removeDocumentLock(String owner)` Removes a lock from this recently created and unsaved document.
`boolean`	`removeFacet(String facet)` Removes a facet from this document.
`void`	`restore(Document version)` Replaces this document's content with the version specified.
`void`	`setCurrentLifeCycleState(String lifeCycleState)` Sets the life cycle state of this document.
`protected Lock`	`setDocumentLock(Lock lock)` Sets a lock on this recently created and unsaved document.
`void`	`setLifeCyclePolicy(String policy)` Sets the life cycle policy of this document.
`void`	`setPropertyValue(String name, Serializable value)` Sets a simple property value.
`void`	`setReadOnly(boolean readonly)` Sets this document as readonly or not.
`void`	`setRetentionActive(boolean retentionActive)` Sets or unsets this document as under active retention.
`void`	`setSystemProp(String name, Serializable value)` Sets a system property.
`void`	`setTargetDocument(Document target)` Sets the document (version or live document) to which this proxy points.
`void`	`setValue(String xpath, Object value)` Sets a property value.
`String`	`toString()`
`protected void`	`updateList(State state, String name, Field field, String xpath, List<Object> values)` Update a list.
`protected List<State>`	`updateList(State state, String name, Property property)` Update a list.
`protected static boolean`	`validateProxyChangeToken(String userVisibleChangeToken, DBSDocumentState proxyState, DBSDocumentState targetState)`
`boolean`	`validateUserVisibleChangeToken(String userVisibleChangeToken)` Validates that the passed user-visible change token is compatible with the one for this document.
`void`	`visitBlobs(Consumer<Document.BlobAccessor> blobVisitor)` Visits all the blobs of this document and calls the passed blob visitor on each one.
`boolean`	`writeDocumentPart(DocumentPart dp, Document.WriteContext writeContext)` Writes a `DocumentPart` to storage.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SYSPROP_FULLTEXT_SIMPLE
```
public static final String SYSPROP_FULLTEXT_SIMPLE
```
    See Also:
    
    Constant Field Values
  - SYSPROP_FULLTEXT_BINARY
```
public static final String SYSPROP_FULLTEXT_BINARY
```
    See Also:
    
    Constant Field Values
  - SYSPROP_FULLTEXT_JOBID
```
public static final String SYSPROP_FULLTEXT_JOBID
```
    See Also:
    
    Constant Field Values
  - SYSPROP_IS_TRASHED
```
public static final String SYSPROP_IS_TRASHED
```
    See Also:
    
    Constant Field Values
  - KEY_PREFIX
```
public static final String KEY_PREFIX
```
    See Also:
    
    Constant Field Values
  - KEY_ID
```
public static final String KEY_ID
```
    See Also:
    
    Constant Field Values
  - KEY_PARENT_ID
```
public static final String KEY_PARENT_ID
```
    See Also:
    
    Constant Field Values
  - KEY_ANCESTOR_IDS
```
public static final String KEY_ANCESTOR_IDS
```
    See Also:
    
    Constant Field Values
  - KEY_PRIMARY_TYPE
```
public static final String KEY_PRIMARY_TYPE
```
    See Also:
    
    Constant Field Values
  - KEY_MIXIN_TYPES
```
public static final String KEY_MIXIN_TYPES
```
    See Also:
    
    Constant Field Values
  - KEY_NAME
```
public static final String KEY_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_POS
```
public static final String KEY_POS
```
    See Also:
    
    Constant Field Values
  - KEY_ACP
```
public static final String KEY_ACP
```
    See Also:
    
    Constant Field Values
  - KEY_ACL_NAME
```
public static final String KEY_ACL_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_PATH_INTERNAL
```
public static final String KEY_PATH_INTERNAL
```
    See Also:
    
    Constant Field Values
  - KEY_ACL
```
public static final String KEY_ACL
```
    See Also:
    
    Constant Field Values
  - KEY_ACE_USER
```
public static final String KEY_ACE_USER
```
    See Also:
    
    Constant Field Values
  - KEY_ACE_PERMISSION
```
public static final String KEY_ACE_PERMISSION
```
    See Also:
    
    Constant Field Values
  - KEY_ACE_GRANT
```
public static final String KEY_ACE_GRANT
```
    See Also:
    
    Constant Field Values
  - KEY_ACE_CREATOR
```
public static final String KEY_ACE_CREATOR
```
    See Also:
    
    Constant Field Values
  - KEY_ACE_BEGIN
```
public static final String KEY_ACE_BEGIN
```
    See Also:
    
    Constant Field Values
  - KEY_ACE_END
```
public static final String KEY_ACE_END
```
    See Also:
    
    Constant Field Values
  - KEY_ACE_STATUS
```
public static final String KEY_ACE_STATUS
```
    See Also:
    
    Constant Field Values
  - KEY_READ_ACL
```
public static final String KEY_READ_ACL
```
    See Also:
    
    Constant Field Values
  - KEY_IS_RETENTION_ACTIVE
```
public static final String KEY_IS_RETENTION_ACTIVE
```
    See Also:
    
    Constant Field Values
  - KEY_IS_CHECKED_IN
```
public static final String KEY_IS_CHECKED_IN
```
    See Also:
    
    Constant Field Values
  - KEY_IS_VERSION
```
public static final String KEY_IS_VERSION
```
    See Also:
    
    Constant Field Values
  - KEY_IS_LATEST_VERSION
```
public static final String KEY_IS_LATEST_VERSION
```
    See Also:
    
    Constant Field Values
  - KEY_IS_LATEST_MAJOR_VERSION
```
public static final String KEY_IS_LATEST_MAJOR_VERSION
```
    See Also:
    
    Constant Field Values
  - KEY_MAJOR_VERSION
```
public static final String KEY_MAJOR_VERSION
```
    See Also:
    
    Constant Field Values
  - KEY_MINOR_VERSION
```
public static final String KEY_MINOR_VERSION
```
    See Also:
    
    Constant Field Values
  - KEY_VERSION_SERIES_ID
```
public static final String KEY_VERSION_SERIES_ID
```
    See Also:
    
    Constant Field Values
  - KEY_VERSION_CREATED
```
public static final String KEY_VERSION_CREATED
```
    See Also:
    
    Constant Field Values
  - KEY_VERSION_LABEL
```
public static final String KEY_VERSION_LABEL
```
    See Also:
    
    Constant Field Values
  - KEY_VERSION_DESCRIPTION
```
public static final String KEY_VERSION_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - KEY_BASE_VERSION_ID
```
public static final String KEY_BASE_VERSION_ID
```
    See Also:
    
    Constant Field Values
  - KEY_IS_PROXY
```
public static final String KEY_IS_PROXY
```
    See Also:
    
    Constant Field Values
  - KEY_PROXY_TARGET_ID
```
public static final String KEY_PROXY_TARGET_ID
```
    See Also:
    
    Constant Field Values
  - KEY_PROXY_VERSION_SERIES_ID
```
public static final String KEY_PROXY_VERSION_SERIES_ID
```
    See Also:
    
    Constant Field Values
  - KEY_PROXY_IDS
```
public static final String KEY_PROXY_IDS
```
    See Also:
    
    Constant Field Values
  - KEY_LIFECYCLE_POLICY
```
public static final String KEY_LIFECYCLE_POLICY
```
    See Also:
    
    Constant Field Values
  - KEY_LIFECYCLE_STATE
```
public static final String KEY_LIFECYCLE_STATE
```
    See Also:
    
    Constant Field Values
  - KEY_IS_TRASHED
```
public static final String KEY_IS_TRASHED
```
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - KEY_LOCK_OWNER
```
public static final String KEY_LOCK_OWNER
```
    See Also:
    
    Constant Field Values
  - KEY_LOCK_CREATED
```
public static final String KEY_LOCK_CREATED
```
    See Also:
    
    Constant Field Values
  - KEY_SYS_CHANGE_TOKEN
```
public static final String KEY_SYS_CHANGE_TOKEN
```
    See Also:
    
    Constant Field Values
  - KEY_CHANGE_TOKEN
```
public static final String KEY_CHANGE_TOKEN
```
    See Also:
    
    Constant Field Values
  - KEY_DC_MODIFIED
```
public static final String KEY_DC_MODIFIED
```
    See Also:
    
    Constant Field Values
  - KEY_BLOB_NAME
```
public static final String KEY_BLOB_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_BLOB_MIME_TYPE
```
public static final String KEY_BLOB_MIME_TYPE
```
    See Also:
    
    Constant Field Values
  - KEY_BLOB_ENCODING
```
public static final String KEY_BLOB_ENCODING
```
    See Also:
    
    Constant Field Values
  - KEY_BLOB_DIGEST
```
public static final String KEY_BLOB_DIGEST
```
    See Also:
    
    Constant Field Values
  - KEY_BLOB_LENGTH
```
public static final String KEY_BLOB_LENGTH
```
    See Also:
    
    Constant Field Values
  - KEY_BLOB_DATA
```
public static final String KEY_BLOB_DATA
```
    See Also:
    
    Constant Field Values
  - KEY_FULLTEXT_SIMPLE
```
public static final String KEY_FULLTEXT_SIMPLE
```
    See Also:
    
    Constant Field Values
  - KEY_FULLTEXT_BINARY
```
public static final String KEY_FULLTEXT_BINARY
```
    See Also:
    
    Constant Field Values
  - KEY_FULLTEXT_JOBID
```
public static final String KEY_FULLTEXT_JOBID
```
    See Also:
    
    Constant Field Values
  - KEY_FULLTEXT_SCORE
```
public static final String KEY_FULLTEXT_SCORE
```
    See Also:
    
    Constant Field Values
  - APPLICATION_OCTET_STREAM
```
public static final String APPLICATION_OCTET_STREAM
```
    See Also:
    
    Constant Field Values
  - PROP_UID_MAJOR_VERSION
```
public static final String PROP_UID_MAJOR_VERSION
```
    See Also:
    
    Constant Field Values
  - PROP_UID_MINOR_VERSION
```
public static final String PROP_UID_MINOR_VERSION
```
    See Also:
    
    Constant Field Values
  - PROP_MAJOR_VERSION
```
public static final String PROP_MAJOR_VERSION
```
    See Also:
    
    Constant Field Values
  - PROP_MINOR_VERSION
```
public static final String PROP_MINOR_VERSION
```
    See Also:
    
    Constant Field Values
  - FACETED_TAG
```
public static final String FACETED_TAG
```
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - FACETED_TAG_LABEL
```
public static final String FACETED_TAG_LABEL
```
    Since:
    
    9.3
    
    See Also:
    
    Constant Field Values
  - INITIAL_SYS_CHANGE_TOKEN
```
public static final Long INITIAL_SYS_CHANGE_TOKEN
```
  - INITIAL_CHANGE_TOKEN
```
public static final Long INITIAL_CHANGE_TOKEN
```
  - id
```
protected final String id
```
  - docState
```
protected final DBSDocumentState docState
```
  - type
```
protected final DocumentType type
```
  - proxySchemas
```
protected final List<Schema> proxySchemas
```
  - session
```
protected final DBSSession session
```
  - readonly
```
protected boolean readonly
```
  - systemPropNameMap
```
protected static final Map<String,String> systemPropNameMap
```
  - CHANGE_TOKEN_PROXY_SEP
```
public static final String CHANGE_TOKEN_PROXY_SEP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DBSDocument
```
public DBSDocument(DBSDocumentState docState,
                   DocumentType type,
                   DBSSession session,
                   boolean readonly)
```
- Method Detail
  - getType
```
public DocumentType getType()
```
    Description copied from interface: Document
    
    Gets the type of this document.
    
    Returns:
    
    the document type
  - getSession
```
public Session getSession()
```
    Description copied from interface: Document
    
    Gets the session that owns this document.
    
    Returns:
    
    the session
  - getRepositoryName
```
public String getRepositoryName()
```
    Description copied from interface: Document
    
    Gets the repository in which the document lives.
    
    Returns:
    
    the repository name.
  - getProxySchemas
```
protected List<Schema> getProxySchemas()
```
    Description copied from class: BaseDocument
    
    Gets the list of proxy schemas, if this is a proxy.
    
    Specified by:
    
    getProxySchemas in class BaseDocument<State>
    
    Returns:
    
    the proxy schemas, or null
  - getUUID
```
public String getUUID()
```
    Description copied from interface: Document
    
    Gets this document's UUID.
    
    Returns:
    
    the document UUID
  - getName
```
public String getName()
```
    Description copied from interface: Document
    
    Gets the name of this document.
    
    Returns:
    
    the document name
  - getPos
```
public Long getPos()
```
    Description copied from interface: Document
    
    Gets the document's position in its containing folder (if ordered).
    
    Returns:
    
    the position
  - getParent
```
public Document getParent()
```
    Description copied from interface: Document
    
    Gets the parent document, or null if this is the root document.
    
    Returns:
    
    the parent document, or null
  - isProxy
```
public boolean isProxy()
```
    Description copied from interface: Document
    
    Checks whether or not this document is a proxy.
    
    Returns:
    
    true if this document is a proxy, false otherwise
  - isVersion
```
public boolean isVersion()
```
    Description copied from interface: Document
    
    Checks whether this document is a version document.
    
    Returns:
    
    true if it's a version, false otherwise
  - getPath
```
public String getPath()
```
    Description copied from interface: Document
    
    Gets the path of this document.
    
    Returns:
    
    the path
  - getChild
```
public Document getChild(String name)
```
    Description copied from interface: Document
    
    Gets a child document given its name.
    Throws DocumentNotFoundException if the document could not be found.
    
    Parameters:
    
    name - the name of the child to retrieve
    
    Returns:
    
    the child if exists
  - getChildren
```
public List<Document> getChildren()
```
    Description copied from interface: Document
    
    Gets the children of the document.
    Returns an empty list for non-folder documents.
    
    Returns:
    
    the children
  - getChildrenIds
```
public List<String> getChildrenIds()
```
    Description copied from interface: Document
    
    Gets a list of the children ids.
    Returns an empty list for non-folder documents.
    
    Returns:
    
    a list of children ids.
  - hasChild
```
public boolean hasChild(String name)
```
    Description copied from interface: Document
    
    Checks whether this document has a child of the given name.
    Returns false for non-folder documents.
    
    Parameters:
    
    name - the name of the child to check
    
    Returns:
    
    true if the child exists, false otherwise
  - hasChildren
```
public boolean hasChildren()
```
    Description copied from interface: Document
    
    Tests if the document has any children.
    Returns false for non-folder documents.
    
    Returns:
    
    true if the document has children, false otherwise
  - addChild
```
public Document addChild(String name,
                         String typeName)
```
    Description copied from interface: Document
    
    Creates a new child document of the given type.
    Throws an error if this document is not a folder.
    
    Parameters:
    
    name - the name of the new child to create
    
    typeName - the type of the child to create
    
    Returns:
    
    the newly created document
  - orderBefore
```
public void orderBefore(String src,
                        String dest)
```
    Description copied from interface: Document
    
    Orders the given source child before the destination child.
    Both source and destination must be names that point to child documents of this document. The source document will be placed before the destination one. If destination is null, the source document will be appended at the end of the children list.
    
    Parameters:
    
    src - the document to move
    
    dest - the document before which to place the source document
  - getPropertyValue
```
public Serializable getPropertyValue(String name)
```
    Description copied from interface: Document
    
    Gets a simple property value.
    For more generic properties described by an xpath, use Document.getValue(java.lang.String) instead.
    
    Parameters:
    
    name - the name of the property to get
    
    Returns:
    
    the property value or null if the property is not set
    
    See Also:
    
    Document.getValue(java.lang.String)
  - setPropertyValue
```
public void setPropertyValue(String name,
                             Serializable value)
```
    Description copied from interface: Document
    
    Sets a simple property value.
    For more generic properties described by an xpath, use Document.setValue(java.lang.String, java.lang.Object) instead.
    
    Parameters:
    
    name - the name of the property to set
    
    value - the value to set
    
    See Also:
    
    Document.setValue(java.lang.String, java.lang.Object)
  - getChild
```
protected State getChild(State state,
                         String name,
                         Type type)
```
    Description copied from class: BaseDocument
    
    Gets a child state.
    
    Specified by:
    
    getChild in class BaseDocument<State>
    
    Parameters:
    
    state - the parent state
    
    name - the child name
    
    type - the child's type
    
    Returns:
    
    the child state, or null if it doesn't exist
  - getChildForWrite
```
protected State getChildForWrite(State state,
                                 String name,
                                 Type type)
                          throws PropertyException
```
    Description copied from class: BaseDocument
    
    Gets a child state into which we will want to write data.
    Creates it if needed.
    
    Specified by:
    
    getChildForWrite in class BaseDocument<State>
    
    Parameters:
    
    state - the parent state
    
    name - the child name
    
    type - the child's type
    
    Returns:
    
    the child state, never null
    
    Throws:
    
    PropertyException
  - getChildAsList
```
protected List<State> getChildAsList(State state,
                                     String name)
```
    Description copied from class: BaseDocument
    
    Gets a child state which is a list.
    
    Specified by:
    
    getChildAsList in class BaseDocument<State>
    
    Parameters:
    
    state - the parent state
    
    name - the child name
    
    Returns:
    
    the child state, never null
  - updateList
```
protected void updateList(State state,
                          String name,
                          Field field,
                          String xpath,
                          List<Object> values)
```
    Description copied from class: BaseDocument
    
    Update a list.
    
    Specified by:
    
    updateList in class BaseDocument<State>
    
    Parameters:
    
    state - the parent state
    
    name - the child name
    
    field - the list element type
    
    xpath - the xpath of this list
    
    values - the values
  - updateList
```
protected List<State> updateList(State state,
                                 String name,
                                 Property property)
                          throws PropertyException
```
    Description copied from class: BaseDocument
    
    Update a list.
    
    Specified by:
    
    updateList in class BaseDocument<State>
    
    Parameters:
    
    state - the parent state
    
    name - the child name
    
    property - the property
    
    Returns:
    
    the list of states to write
    
    Throws:
    
    PropertyException
  - getValue
```
public Object getValue(String xpath)
                throws PropertyException
```
    Description copied from interface: Document
    
    Gets a property value.
    The xpath may point to a partial path, in which case the value may be a complex List or Map.
    
    Parameters:
    
    xpath - the xpath of the property to set
    
    Returns:
    
    the property value or null if the property is not set
    
    Throws:
    
    PropertyException - if the property does not exist
  - setValue
```
public void setValue(String xpath,
                     Object value)
              throws PropertyException
```
    Description copied from interface: Document
    
    Sets a property value.
    The xpath may point to a partial path, in which case the value may be a complex List or Map.
    
    Parameters:
    
    xpath - the xpath of the property to set
    
    value - the value to set
    
    Throws:
    
    PropertyException - if the property does not exist or the value is of the wrong type
  - visitBlobs
```
public void visitBlobs(Consumer<Document.BlobAccessor> blobVisitor)
                throws PropertyException
```
    Description copied from interface: Document
    
    Visits all the blobs of this document and calls the passed blob visitor on each one.
    
    Throws:
    
    PropertyException
  - isRetentionActive
```
public boolean isRetentionActive()
```
    Description copied from interface: Document
    
    Checks whether this document is under active retention.
  - setRetentionActive
```
public void setRetentionActive(boolean retentionActive)
```
    Description copied from interface: Document
    
    Sets or unsets this document as under active retention.
  - checkIn
```
public Document checkIn(String label,
                        String checkinComment)
```
    Description copied from interface: Document
    
    Creates a new version.
    
    Parameters:
    
    label - the version label
    
    checkinComment - the checkin comment
    
    Returns:
    
    the created version
  - checkOut
```
public void checkOut()
```
  - getVersionsIds
```
public List<String> getVersionsIds()
```
    Description copied from interface: Document
    
    Gets the list of version ids for this document.
    
    Returns:
    
    the list of version ids
  - getVersions
```
public List<Document> getVersions()
```
    Description copied from interface: Document
    
    Gets the versions for this document.
    
    Returns:
    
    the versions of the document, or an empty list if there are no versions
  - getLastVersion
```
public Document getLastVersion()
```
    Description copied from interface: Document
    
    Gets the last version of this document.
    Returns null if there is no version at all.
    
    Returns:
    
    the last version, or null if there is no version
  - getSourceDocument
```
public Document getSourceDocument()
```
    Description copied from interface: Document
    
    Gets the source for this document.
    For a version, it's the working copy.
    For a proxy, it's the version the proxy points to.
    
    Returns:
    
    the source document
  - restore
```
public void restore(Document version)
```
    Description copied from interface: Document
    
    Replaces this document's content with the version specified.
    
    Parameters:
    
    version - the version to replace with
  - getVersion
```
public Document getVersion(String label)
```
    Description copied from interface: Document
    
    Gets a version of this document, given its label.
    
    Parameters:
    
    label - the version label
    
    Returns:
    
    the version
  - getBaseVersion
```
public Document getBaseVersion()
```
    Description copied from interface: Document
    
    Gets the version to which a checked in document is linked.
    Returns null for a checked out document or a version or a proxy.
    
    Returns:
    
    the version, or null
  - isCheckedOut
```
public boolean isCheckedOut()
```
    Description copied from interface: Document
    
    Checks whether this document is checked out.
    
    Returns:
    
    true if the document is checked out, or false otherwise
  - getVersionSeriesId
```
public String getVersionSeriesId()
```
    Description copied from interface: Document
    
    Gets the version series id.
    
    Returns:
    
    the version series id
  - getVersionCreationDate
```
public Calendar getVersionCreationDate()
```
    Description copied from interface: Document
    
    Gets the version creation date of this document if it's a version or a proxy.
    
    Returns:
    
    the version creation date, or null if it's not a version or a proxy
  - getVersionLabel
```
public String getVersionLabel()
```
    Description copied from interface: Document
    
    Gets the version label.
    
    Returns:
    
    the version label
  - getCheckinComment
```
public String getCheckinComment()
```
    Description copied from interface: Document
    
    Gets the version check in comment of this document if it's a version or a proxy.
    
    Returns:
    
    the check in comment, or null if it's not a version or a proxy
  - isLatestVersion
```
public boolean isLatestVersion()
```
    Description copied from interface: Document
    
    Checks whether this document is the latest version.
    
    Returns:
    
    true if this is the latest version, or false otherwise
  - isMajorVersion
```
public boolean isMajorVersion()
```
    Description copied from interface: Document
    
    Checks whether this document is a major version.
    
    Returns:
    
    true if this is a major version, or false otherwise
  - isLatestMajorVersion
```
public boolean isLatestMajorVersion()
```
    Description copied from interface: Document
    
    Checks whether this document is the latest major version.
    
    Returns:
    
    true if this is the latest major version, or false otherwise
  - isEqualOnVersion
```
protected boolean isEqualOnVersion(Object ob,
                                   String key)
```
  - isVersionSeriesCheckedOut
```
public boolean isVersionSeriesCheckedOut()
```
    Description copied from interface: Document
    
    Checks if there is a checked out working copy for the version series of this document.
    
    Returns:
    
    true if there is a checked out working copy
  - getWorkingCopy
```
public Document getWorkingCopy()
```
    Description copied from interface: Document
    
    Gets the working copy for this document.
    
    Returns:
    
    the working copy
  - isFolder
```
public boolean isFolder()
```
    Description copied from interface: Document
    
    Checks whether this document is a folder.
    
    Returns:
    
    true if the document is a folder, false otherwise
  - setReadOnly
```
public void setReadOnly(boolean readonly)
```
    Description copied from interface: Document
    
    Sets this document as readonly or not.
  - isReadOnly
```
public boolean isReadOnly()
```
    Description copied from interface: Document
    
    Checks whether this document is readonly or not.
  - remove
```
public void remove()
```
    Description copied from interface: Document
    
    Removes this document and all its children, if any.
  - getLifeCycleState
```
public String getLifeCycleState()
```
    Description copied from interface: Document
    
    Gets the life cycle state of this document.
    
    Returns:
    
    the life cycle state
  - setCurrentLifeCycleState
```
public void setCurrentLifeCycleState(String lifeCycleState)
                              throws LifeCycleException
```
    Description copied from interface: Document
    
    Sets the life cycle state of this document.
    
    Parameters:
    
    lifeCycleState - the life cycle state
    
    Throws:
    
    LifeCycleException
  - getLifeCyclePolicy
```
public String getLifeCyclePolicy()
```
    Description copied from interface: Document
    
    Gets the life cycle policy of this document.
    
    Returns:
    
    the life cycle policy
  - setLifeCyclePolicy
```
public void setLifeCyclePolicy(String policy)
                        throws LifeCycleException
```
    Description copied from interface: Document
    
    Sets the life cycle policy of this document.
    
    Parameters:
    
    policy - the life cycle policy
    
    Throws:
    
    LifeCycleException
  - followTransition
```
public void followTransition(String transition)
                      throws LifeCycleException
```
    Description copied from interface: Document
    
    Follows a given life cycle transition.
    This will update the life cycle state of the document.
    
    Parameters:
    
    transition - the name of the transition to follow
    
    Throws:
    
    LifeCycleException
  - getAllowedStateTransitions
```
public Collection<String> getAllowedStateTransitions()
                                              throws LifeCycleException
```
    Description copied from interface: Document
    
    Returns the allowed state transitions for this document.
    
    Returns:
    
    a collection of state transitions
    
    Throws:
    
    LifeCycleException
  - setSystemProp
```
public void setSystemProp(String name,
                          Serializable value)
```
    Description copied from interface: Document
    
    Sets a system property.
  - getSystemProp
```
public <T extends Serializable> T getSystemProp(String name,
                                                Class<T> type)
```
    Description copied from interface: Document
    
    Gets a system property.
  - getChangeToken
```
public String getChangeToken()
```
    Description copied from interface: Document
    
    Gets the current change token for this document.
    
    Returns:
    
    the change token
  - getProxyUserVisibleChangeToken
```
protected static String getProxyUserVisibleChangeToken(String proxyToken,
                                                       String targetToken)
```
  - validateUserVisibleChangeToken
```
public boolean validateUserVisibleChangeToken(String userVisibleChangeToken)
```
    Description copied from interface: Document
    
    Validates that the passed user-visible change token is compatible with the one for this document.
    
    Returns:
    
    false if the change token is not valid
  - validateProxyChangeToken
```
protected static boolean validateProxyChangeToken(String userVisibleChangeToken,
                                                  DBSDocumentState proxyState,
                                                  DBSDocumentState targetState)
```
  - markUserChange
```
public void markUserChange()
```
    Description copied from interface: Document
    
    Marks the document as being modified by a user change.
    This causes an additional change token increment and check during save.
  - getStateOrTarget
```
protected DBSDocumentState getStateOrTarget(Type type)
                                     throws PropertyException
```
    Throws:
    
    PropertyException
  - getStateOrTarget
```
protected DBSDocumentState getStateOrTarget(String xpath)
```
  - getStateOrTargetForSchema
```
protected DBSDocumentState getStateOrTargetForSchema(String schema)
```
    Checks if the given schema should be resolved on the proxy or the target.
  - getStateOrTarget
```
protected DBSDocumentState getStateOrTarget()
```
    Gets the target state if this is a proxy, or the regular state otherwise.
  - isSchemaForProxy
```
protected boolean isSchemaForProxy(String schema)
```
  - getSchema
```
protected String getSchema(String xpath)
```
  - readDocumentPart
```
public void readDocumentPart(DocumentPart dp)
                      throws PropertyException
```
    Description copied from interface: Document
    
    Loads a DocumentPart from storage.
    Reading data is done by DocumentPart because of per-proxy schemas.
    
    Throws:
    
    PropertyException
  - internalName
```
protected String internalName(String name)
```
    Description copied from class: BaseDocument
    
    Finds the internal name to use to refer to this property.
    
    Specified by:
    
    internalName in class BaseDocument<State>
  - writeDocumentPart
```
public boolean writeDocumentPart(DocumentPart dp,
                                 Document.WriteContext writeContext)
                          throws PropertyException
```
    Description copied from interface: Document
    
    Writes a DocumentPart to storage.
    Writing data is done by DocumentPart because of per-proxy schemas.
    
    Returns:
    
    true if something changed
    
    Throws:
    
    PropertyException
  - getAllFacets
```
public Set<String> getAllFacets()
```
    Description copied from interface: Document
    
    Gets the facets available on this document (from the type and the instance facets).
    
    Returns:
    
    the facets
  - getFacets
```
public String[] getFacets()
```
    Description copied from interface: Document
    
    Gets the facets defined on this document instance. The type facets are not returned.
    
    Returns:
    
    the facets
  - hasFacet
```
public boolean hasFacet(String facet)
```
    Description copied from interface: Document
    
    Checks whether this document has a given facet, either from its type or added on the instance.
    
    Parameters:
    
    facet - the facet name
    
    Returns:
    
    true if the document has the facet
  - addFacet
```
public boolean addFacet(String facet)
```
    Description copied from interface: Document
    
    Adds a facet to this document.
    Does nothing if the facet was already present on the document.
    
    Parameters:
    
    facet - the facet name
    
    Returns:
    
    true if the facet was added, or false if it is already present
  - removeFacet
```
public boolean removeFacet(String facet)
```
    Description copied from interface: Document
    
    Removes a facet from this document.
    It's not possible to remove a facet coming from the document type.
    
    Parameters:
    
    facet - the facet name
    
    Returns:
    
    true if the facet was removed, or false if it isn't present or is present on the type or does not exit
  - getSchemas
```
protected static Set<String> getSchemas(DocumentType type,
                                        List<Object> facets)
```
  - getTargetDocument
```
public DBSDocument getTargetDocument()
```
    Description copied from interface: Document
    
    Gets the document (version or live document) to which this proxy points.
  - getTargetDocumentId
```
protected String getTargetDocumentId()
```
  - setTargetDocument
```
public void setTargetDocument(Document target)
```
    Description copied from interface: Document
    
    Sets the document (version or live document) to which this proxy points.
  - getDocumentLock
```
protected Lock getDocumentLock()
```
    Description copied from class: BaseDocument
    
    Gets the lock from this recently created and unsaved document.
    
    Specified by:
    
    getDocumentLock in class BaseDocument<State>
    
    Returns:
    
    the lock, or null if no lock is set
  - setDocumentLock
```
protected Lock setDocumentLock(Lock lock)
```
    Description copied from class: BaseDocument
    
    Sets a lock on this recently created and unsaved document.
    
    Specified by:
    
    setDocumentLock in class BaseDocument<State>
    
    Parameters:
    
    lock - the lock to set
    
    Returns:
    
    null if locking succeeded, or the existing lock if locking failed
  - removeDocumentLock
```
protected Lock removeDocumentLock(String owner)
```
    Description copied from class: BaseDocument
    
    Removes a lock from this recently created and unsaved document.
    
    Specified by:
    
    removeDocumentLock in class BaseDocument<State>
    
    Parameters:
    
    owner - the owner to check, or null for no check
    
    Returns:
    
    null if there was no lock or if removal succeeded, or a lock if it blocks removal due to owner mismatch
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class DBSDocument

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.core.storage.BaseDocument

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.model.Document

Field Summary

Fields inherited from class org.nuxeo.ecm.core.storage.BaseDocument

Constructor Summary

Method Summary

Methods inherited from class org.nuxeo.ecm.core.storage.BaseDocument

Methods inherited from class java.lang.Object

Field Detail

SYSPROP_FULLTEXT_SIMPLE

SYSPROP_FULLTEXT_BINARY

SYSPROP_FULLTEXT_JOBID

SYSPROP_IS_TRASHED

KEY_PREFIX

KEY_ID

KEY_PARENT_ID

KEY_ANCESTOR_IDS

KEY_PRIMARY_TYPE

KEY_MIXIN_TYPES

KEY_NAME

KEY_POS

KEY_ACP

KEY_ACL_NAME

KEY_PATH_INTERNAL

KEY_ACL

KEY_ACE_USER

KEY_ACE_PERMISSION

KEY_ACE_GRANT

KEY_ACE_CREATOR

KEY_ACE_BEGIN

KEY_ACE_END

KEY_ACE_STATUS

KEY_READ_ACL

KEY_IS_RETENTION_ACTIVE

KEY_IS_CHECKED_IN

KEY_IS_VERSION

KEY_IS_LATEST_VERSION

KEY_IS_LATEST_MAJOR_VERSION

KEY_MAJOR_VERSION

KEY_MINOR_VERSION

KEY_VERSION_SERIES_ID

KEY_VERSION_CREATED

KEY_VERSION_LABEL

KEY_VERSION_DESCRIPTION

KEY_BASE_VERSION_ID

KEY_IS_PROXY

KEY_PROXY_TARGET_ID

KEY_PROXY_VERSION_SERIES_ID

KEY_PROXY_IDS

KEY_LIFECYCLE_POLICY

KEY_LIFECYCLE_STATE

KEY_IS_TRASHED

KEY_LOCK_OWNER

KEY_LOCK_CREATED

KEY_SYS_CHANGE_TOKEN

KEY_CHANGE_TOKEN

KEY_DC_MODIFIED

KEY_BLOB_NAME

KEY_BLOB_MIME_TYPE

KEY_BLOB_ENCODING

KEY_BLOB_DIGEST

KEY_BLOB_LENGTH

KEY_BLOB_DATA

KEY_FULLTEXT_SIMPLE

KEY_FULLTEXT_BINARY

KEY_FULLTEXT_JOBID

KEY_FULLTEXT_SCORE

APPLICATION_OCTET_STREAM

PROP_UID_MAJOR_VERSION

PROP_UID_MINOR_VERSION

PROP_MAJOR_VERSION

PROP_MINOR_VERSION

FACETED_TAG

FACETED_TAG_LABEL

INITIAL_SYS_CHANGE_TOKEN

INITIAL_CHANGE_TOKEN

id

docState