org.nuxeo.ecm.core.storage.sql.coremodel

Class SQLDocumentLive

java.lang.Object

org.nuxeo.ecm.core.storage.BaseDocument<Node>

org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocumentLive

All Implemented Interfaces:

Document, SQLDocument

Direct Known Subclasses:

SQLDocumentVersion

public class SQLDocumentLive
extends BaseDocument<Node>
implements SQLDocument

Nested Class Summary

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

BaseDocument.BlobWriteContext<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
protected Node	node
protected List<Schema>	proxySchemas Proxy-induced types.
protected boolean	readonly Read-only flag, used to allow/disallow writes on versions.
protected SQLSession	session
protected static Map<String,String>	systemPropNameMap
protected Type	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_PREFIX, EMPTY_STRING_ARRAY, FULLTEXT_BINARYTEXT_PROP, FULLTEXT_JOBID_PROP, FULLTEXT_SIMPLETEXT_PROP, LOCK_CREATED_PROP, LOCK_OWNER_PROP, MISC_LIFECYCLE_STATE_PROP, NO_DIRTY, NON_CANONICAL_INDEX, RELATED_TEXT, RELATED_TEXT_ID, RELATED_TEXT_RESOURCES, VERSION_WRITABLE_PROPS

Fields inherited from interface org.nuxeo.ecm.core.storage.sql.coremodel.SQLDocument

BINARY_TEXT_SYS_PROP, FULLTEXT_JOBID_SYS_PROP, SIMPLE_TEXT_SYS_PROP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SQLDocumentLive(Node node, ComplexType type, SQLSession session, boolean readonly)

Method Summary

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	getCheckinComment() Gets the version check in comment of this document if it's a version or a proxy.
protected Node	getChild(Node node, String name, Type type) Gets a child state.
Document	getChild(String name) Gets a child document given its name.
protected List<Node>	getChildAsList(Node node, String name) Gets a child state which is a list.
protected Node	getChildForWrite(Node node, 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.
Node	getNode() Returns the node with info about the hierarchy location.
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.
String	getRepositoryName() Gets the repository in which the document lives.
SQLSession	getSession() Gets the session that owns this document.
Document	getSourceDocument() Gets the source for this document.
<T extends Serializable> T	getSystemProp(String name, Class<T> type) Gets a system property.
Document	getTargetDocument() Gets the document (version or live document) to which this proxy points.
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.
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	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	orderBefore(String src, String dest) Orders the given source child before the destination child.
void	readDocumentPart(DocumentPart dp) Reads into the DocumentPart the values from this SQLDocument.
Map<String,Serializable>	readPrefetch(ComplexType complexType, Set<String> xpaths) Reads a set of prefetched fields.
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 state) 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	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(Node node, String name, List<Object> values, Field field) Update a list.
protected List<Node>	updateList(Node node, String name, Property property) Update a list.
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 org.nuxeo.ecm.core.storage.BaseDocument

canonicalXPath, checkReadOnlyIgnoredWrite, clearDirtyFlags, getBlobInfo, getLock, getValueBlob, getValueComplex, getValueField, getValueObject, getWriteContext, isVersionWritableProperty, readComplexProperty, readPrefetch, readPrefetch, readPrefetchField, removeLock, setBlobInfo, setLock, setValueBlob, setValueComplex, setValueField, setValueObject, typedArray, visitBlobs, writeComplexProperty, writeComplexProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.model.Document

getLock, getWriteContext, removeLock, setLock

Field Detail

node

protected final Node node

type

protected final Type type

session

protected SQLSession session

proxySchemas

protected final List<Schema> proxySchemas

Proxy-induced types.

readonly

protected boolean readonly

Read-only flag, used to allow/disallow writes on versions.

systemPropNameMap

protected static final Map<String,String> systemPropNameMap

Constructor Detail

SQLDocumentLive

protected SQLDocumentLive(Node node,
                          ComplexType type,
                          SQLSession session,
                          boolean readonly)

Method Detail

setReadOnly

public void setReadOnly(boolean readonly)

Description copied from interface: Document

Sets this document as readonly or not.

Specified by:

setReadOnly in interface Document

isReadOnly

public boolean isReadOnly()

Description copied from interface: Document

Checks whether this document is readonly or not.

Specified by:

isReadOnly in interface Document

getNode

public Node getNode()

Description copied from interface: SQLDocument

Returns the node with info about the hierarchy location.

Specified by:

getNode in interface SQLDocument

getName

public String getName()

Description copied from interface: Document

Gets the name of this document.

Specified by:

getName in interface 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).

Specified by:

getPos in interface Document

Returns:

the position

getType

public DocumentType getType()

Description copied from interface: Document

Gets the type of this document.

Specified by:

getType in interface Document

Returns:

the document type

getSession

public SQLSession getSession()

Description copied from interface: Document

Gets the session that owns this document.

Specified by:

getSession in interface Document

Returns:

the session

isFolder

public boolean isFolder()

Description copied from interface: Document

Checks whether this document is a folder.

Specified by:

isFolder in interface Document

Returns:

true if the document is a folder, false otherwise

getUUID

public String getUUID()

Description copied from interface: Document

Gets this document's UUID.

Specified by:

getUUID in interface Document

Returns:

the document UUID

getParent

public Document getParent()

Description copied from interface: Document

Gets the parent document, or null if this is the root document.

Specified by:

getParent in interface Document

Returns:

the parent document, or null

getPath

public String getPath()

Description copied from interface: Document

Gets the path of this document.

Specified by:

getPath in interface Document

Returns:

the path

isProxy

public boolean isProxy()

Description copied from interface: Document

Checks whether or not this document is a proxy.

Specified by:

isProxy in interface Document

Returns:

true if this document is a proxy, false otherwise

getRepositoryName

public String getRepositoryName()

Description copied from interface: Document

Gets the repository in which the document lives.

Specified by:

getRepositoryName in interface Document

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<Node>

Returns:

the proxy schemas, or null

remove

public void remove()

Description copied from interface: Document

Removes this document and all its children, if any.

Specified by:

remove in interface Document

readDocumentPart

public void readDocumentPart(DocumentPart dp)
                      throws PropertyException

Reads into the DocumentPart the values from this SQLDocument.

Specified by:

readDocumentPart in interface Document

Throws:

PropertyException

readPrefetch

public Map<String,Serializable> readPrefetch(ComplexType complexType,
                                             Set<String> xpaths)
                                      throws PropertyException

Description copied from interface: Document

Reads a set of prefetched fields.

Reading data is done by ComplexType because of per-proxy schemas.

Specified by:

readPrefetch in interface Document

Throws:

PropertyException

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.

Specified by:

writeDocumentPart in interface Document

Returns:

true if something changed

Throws:

PropertyException

getChild

protected Node getChild(Node node,
                        String name,
                        Type type)
                 throws PropertyException

Description copied from class: BaseDocument

Gets a child state.

Specified by:

getChild in class BaseDocument<Node>

Parameters:

node - the parent state

name - the child name

type - the child's type

Returns:

the child state, or null if it doesn't exist

Throws:

PropertyException

getChildForWrite

protected Node getChildForWrite(Node node,
                                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<Node>

Parameters:

node - the parent state

name - the child name

type - the child's type

Returns:

the child state, never null

Throws:

PropertyException

getChildAsList

protected List<Node> getChildAsList(Node node,
                                    String name)
                             throws PropertyException

Description copied from class: BaseDocument

Gets a child state which is a list.

Specified by:

getChildAsList in class BaseDocument<Node>

Parameters:

node - the parent state

name - the child name

Returns:

the child state, never null

Throws:

PropertyException

updateList

protected void updateList(Node node,
                          String name,
                          List<Object> values,
                          Field field)
                   throws PropertyException

Description copied from class: BaseDocument

Update a list.

Specified by:

updateList in class BaseDocument<Node>

Parameters:

node - the parent state

name - the child name

values - the values

field - the list element type

Throws:

PropertyException

updateList

protected List<Node> updateList(Node node,
                                String name,
                                Property property)
                         throws PropertyException

Description copied from class: BaseDocument

Update a list.

Specified by:

updateList in class BaseDocument<Node>

Parameters:

node - the parent state

name - the child name

property - the property

Returns:

the list of states to write

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<Node>

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.

Specified by:

getValue in interface Document

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.

Specified by:

setValue in interface Document

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.

Specified by:

visitBlobs in interface Document

Throws:

PropertyException

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.

Specified by:

getPropertyValue in interface Document

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.

Specified by:

setPropertyValue in interface Document

Parameters:

name - the name of the property to set

value - the value to set

See Also:

Document.setValue(java.lang.String, java.lang.Object)

setSystemProp

public void setSystemProp(String name,
                          Serializable value)

Description copied from interface: Document

Sets a system property.

Specified by:

setSystemProp in interface Document

getSystemProp

public <T extends Serializable> T getSystemProp(String name,
                                                Class<T> type)

Description copied from interface: Document

Gets a system property.

Specified by:

getSystemProp in interface Document

getLifeCyclePolicy

public String getLifeCyclePolicy()

Description copied from interface: Document

Gets the life cycle policy of this document.

Specified by:

getLifeCyclePolicy in interface Document

Returns:

the life cycle policy

setLifeCyclePolicy

public void setLifeCyclePolicy(String policy)

Description copied from interface: Document

Sets the life cycle policy of this document.

Specified by:

setLifeCyclePolicy in interface Document

Parameters:

policy - the life cycle policy

getLifeCycleState

public String getLifeCycleState()

Description copied from interface: Document

Gets the life cycle state of this document.

Specified by:

getLifeCycleState in interface Document

Returns:

the life cycle state

setCurrentLifeCycleState

public void setCurrentLifeCycleState(String state)

Description copied from interface: Document

Sets the life cycle state of this document.

Specified by:

setCurrentLifeCycleState in interface Document

Parameters:

state - the life cycle state

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.

Specified by:

followTransition in interface Document

Parameters:

transition - the name of the transition to follow

Throws:

LifeCycleException

getAllowedStateTransitions

public Collection<String> getAllowedStateTransitions()

Description copied from interface: Document

Returns the allowed state transitions for this document.

Specified by:

getAllowedStateTransitions in interface Document

Returns:

a collection of state transitions

isVersion

public boolean isVersion()

Description copied from interface: Document

Checks whether this document is a version document.

Specified by:

isVersion in interface Document

Returns:

true if it's a version, false otherwise

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.

Specified by:

getBaseVersion in interface Document

Returns:

the version, or null

getVersionSeriesId

public String getVersionSeriesId()

Description copied from interface: Document

Gets the version series id.

Specified by:

getVersionSeriesId in interface Document

Returns:

the version series id

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.

Specified by:

getSourceDocument in interface Document

Returns:

the source document

checkIn

public Document checkIn(String label,
                        String checkinComment)

Description copied from interface: Document

Creates a new version.

Specified by:

checkIn in interface Document

Parameters:

label - the version label

checkinComment - the checkin comment

Returns:

the created version

checkOut

public void checkOut()

Specified by:

checkOut in interface Document

isCheckedOut

public boolean isCheckedOut()

Description copied from interface: Document

Checks whether this document is checked out.

Specified by:

isCheckedOut in interface Document

Returns:

true if the document is checked out, or false otherwise

isMajorVersion

public boolean isMajorVersion()

Description copied from interface: Document

Checks whether this document is a major version.

Specified by:

isMajorVersion in interface Document

Returns:

true if this is a major version, or false otherwise

isLatestVersion

public boolean isLatestVersion()

Description copied from interface: Document

Checks whether this document is the latest version.

Specified by:

isLatestVersion in interface Document

Returns:

true if this is the latest version, or false otherwise

isLatestMajorVersion

public boolean isLatestMajorVersion()

Description copied from interface: Document

Checks whether this document is the latest major version.

Specified by:

isLatestMajorVersion in interface Document

Returns:

true if this is the latest major version, or false otherwise

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.

Specified by:

isVersionSeriesCheckedOut in interface Document

Returns:

true if there is a checked out working copy

getVersionLabel

public String getVersionLabel()

Description copied from interface: Document

Gets the version label.

Specified by:

getVersionLabel in interface Document

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.

Specified by:

getCheckinComment in interface Document

Returns:

the check in comment, or null if it's not a version or a proxy

getWorkingCopy

public Document getWorkingCopy()

Description copied from interface: Document

Gets the working copy for this document.

Specified by:

getWorkingCopy in interface Document

Returns:

the working copy

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.

Specified by:

getVersionCreationDate in interface Document

Returns:

the version creation date, or null if it's not a version or a proxy

restore

public void restore(Document version)

Description copied from interface: Document

Replaces this document's content with the version specified.

Specified by:

restore in interface Document

Parameters:

version - the version to replace with

getVersionsIds

public List<String> getVersionsIds()

Description copied from interface: Document

Gets the list of version ids for this document.

Specified by:

getVersionsIds in interface Document

Returns:

the list of version ids

getVersion

public Document getVersion(String label)

Description copied from interface: Document

Gets a version of this document, given its label.

Specified by:

getVersion in interface Document

Parameters:

label - the version label

Returns:

the version

getVersions

public List<Document> getVersions()

Description copied from interface: Document

Gets the versions for this document.

Specified by:

getVersions in interface 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.

Specified by:

getLastVersion in interface Document

Returns:

the last version, or null if there is no version

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.

Specified by:

getChild in interface Document

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.

Specified by:

getChildren in interface Document

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.

Specified by:

getChildrenIds in interface Document

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.

Specified by:

hasChild in interface Document

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.

Specified by:

hasChildren in interface Document

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.

Specified by:

addChild in interface Document

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.

Specified by:

orderBefore in interface Document

Parameters:

src - the document to move

dest - the document before which to place the source document

getAllFacets

public Set<String> getAllFacets()

Description copied from interface: Document

Gets the facets available on this document (from the type and the instance facets).

Specified by:

getAllFacets in interface Document

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.

Specified by:

getFacets in interface Document

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.

Specified by:

hasFacet in interface Document

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.

Specified by:

addFacet in interface 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.

Specified by:

removeFacet in interface Document

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

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

getTargetDocument

public Document getTargetDocument()

Description copied from interface: Document

Gets the document (version or live document) to which this proxy points.

Specified by:

getTargetDocument in interface Document

setTargetDocument

public void setTargetDocument(Document target)

Description copied from interface: Document

Sets the document (version or live document) to which this proxy points.

Specified by:

setTargetDocument in interface Document

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<Node>

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<Node>

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<Node>

Returns:

null if there was no lock or if removal succeeded, or a lock if it blocks removal due to owner mismatch