java.lang.Object
- com.xpn.xwiki.doc.XWikiDocument
- - com.xpn.xwiki.doc.LazyXWikiDocument

All Implemented Interfaces:

Cloneable, DocumentModelBridge
```
public class LazyXWikiDocument
extends XWikiDocument
```
Read only lazy loading document.
The following informations are taken into account:
- document reference: the absolute reference of the document
- document language: if provided the proper language version of the document is loaded. If not the default one is loaded.
- document version: if provided the proper version of the document is loaded. Also make extra sure to bypass cache storage for remote observation use case.
originalDocument remain the property of LazyXWikiDocument object and is not taken from the lazy loaded document since it depends on how this XWikiDocument object is used (its technical meaning is its state in the database before any modification but in the case of observation it's used as the previous version of the document). TODO: we should probably think about a separation of theses two notions in something more clear, something for the new model.
Since:

2.0M4

Version:

$Id: e215d894834917f828fdedad1e54c9872379f377 $

Nested Class Summary
- Nested classes/interfaces inherited from class com.xpn.xwiki.doc.XWikiDocument
  XWikiDocument.XWikiAttachmentToRemove

Field Summary
- Fields inherited from class com.xpn.xwiki.doc.XWikiDocument
  CKEY_SDOC, COMMENTSCLASS_REFERENCE, DB_SPACE_SEP, HAS_ATTACHMENTS, HAS_CLASS, HAS_OBJECTS, SHEETCLASS_REFERENCE, SPACE_NAME_SEP, version

Constructor Summary

Constructors
Constructor Description

LazyXWikiDocument()
Deprecated.
use LazyXWikiDocument(DocumentReference) instead

LazyXWikiDocument(DocumentReference documentReference)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DocumentReference`	`getAuthorReference()`
`String`	`getComment()`
`String`	`getContent()`
`DocumentReference`	`getContentAuthorReference()`
`Date`	`getContentUpdateDate()`
`Date`	`getCreationDate()`
`DocumentReference`	`getCreatorReference()`
`String`	`getCustomClass()`
`Date`	`getDate()`
`Locale`	`getDefaultLocale()`
`String`	`getDefaultTemplate()`
`XWikiDocumentArchive`	`getDocumentArchive()`
`XWikiDocumentArchive`	`getDocumentArchive(XWikiContext context)`
`int`	`getElements()`
`String`	`getFormat()`
`long`	`getId()`
`String`	`getMeta()`
`DocumentReference`	`getParentReference()`
`org.suigeneris.jrcs.rcs.Version`	`getRCSVersion()`
`EntityReference`	`getRelativeParentReference()`	Return the reference of the parent document as it stored and passed to `XWikiDocument.setParentReference(EntityReference)`.
`XWikiStoreInterface`	`getStore()`
`XWikiStoreInterface`	`getStore(XWikiContext context)`
`org.xwiki.rendering.syntax.Syntax`	`getSyntax()`
`String`	`getTags(XWikiContext context)`
`List<String>`	`getTagsPossibleValues(XWikiContext context)`
`String`	`getTitle()`
`int`	`getTranslation()`
`String`	`getValidationScript()`
`Object`	`getWikiNode()`
`BaseClass`	`getXClass()`
`String`	`getXClassXML()`
`org.xwiki.rendering.block.XDOM`	`getXDOM()`	NOTE: This method caches the XDOM and returns a clone that can be safely modified.
`Map<DocumentReference,List<BaseObject>>`	`getXObjects()`
`boolean`	`isFromCache()`
`Boolean`	`isHidden()`	Indicates whether the document is 'hidden' or not, meaning that it should not be returned in public search results.
`boolean`	`isMostRecent()`
`void`	`loadArchive(XWikiContext context)`
`org.dom4j.Document`	`toXMLDocument(boolean bWithObjects, boolean bWithRendering, boolean bWithAttachmentContent, boolean bWithVersions, XWikiContext context)`	Serialize the document to an XML `DOMDocument`.

Methods inherited from class com.xpn.xwiki.doc.XWikiDocument
addAttachment, addAttachment, addAttachment, addObject, addObjectFromRequest, addObjectFromRequest, addObjectFromRequest, addObjectFromRequest, addObjectsFromRequest, addObjectsFromRequest, addObjectsToRemove, addToZip, addToZip, addToZip, addXObject, addXObject, addXObjectFromRequest, addXObjectFromRequest, addXObjectFromRequest, addXObjectFromRequest, addXObjectFromRequest, addXObjectsFromRequest, addXObjectsFromRequest, addXObjectsToRemoveFromVersion, addXObjectToRemove, appendMeta, apply, apply, backupContext, clearAttachmentsToRemove, clone, clone, cloneRename, cloneXObjects, containsXMLWikiDocument, convertSyntax, convertSyntax, copyAttachments, copyDocument, copyDocument, copyDocument, createNewObject, createXObject, display, display, display, display, display, display, display, display, display, display, display, displayDocument, displayDocument, displayDocument, displayDocument, displayEdit, displayForm, displayForm, displayForm, displayForm, displayForm, displayForm, displayHidden, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayPrettyName, displayRendered, displayTooltip, displayTooltip, displayView, duplicate, duplicateXObjects, encodedXMLStringAsUTF8, equals, equalsData, fromXML, fromXML, fromXML, fromXML, fromXML, fromXML, getAttachment, getAttachmentDiff, getAttachmentList, getAttachmentRevisionURL, getAttachmentRevisionURL, getAttachmentStore, getAttachmentsToRemove, getAttachmentURL, getAttachmentURL, getAttachmentURL, getAuthor, getAuthors, getBackLinkedPages, getBackLinkedReferences, getChildren, getChildren, getChildrenReferences, getChildrenReferences, getClassDiff, getComments, getComments, getContentAuthor, getContentDiff, getContentDiff, getContentDiff, getContentOfSection, getCreator, getDatabase, getDefaultEditMode, getDefaultEditURL, getDefaultLanguage, getDeltas, getDocumentReference, getDocumentReferenceWithLocale, getDocumentSection, getEditURL, getEditURL, getElement, getEscapedContent, getExactAttachment, getExternalAttachmentURL, getExternalURL, getExternalURL, getFirstObject, getFirstObject, getFullName, getIncludedMacros, getIncludedPages, getInternalProperty, getInternalPropertyName, getIntValue, getIntValue, getIntValue, getIntValue, getKey, getLanguage, getLastChanges, getListValue, getListValue, getListValue, getLocale, getLocalReferenceMaxLength, getLock, getLongValue, getLongValue, getLongValue, getMetaDataDiff, getMetaDataDiff, getMetaDataDiff, getMinorEdit1, getName, getNextVersion, getObject, getObject, getObject, getObject, getObject, getObjectDiff, getObjectDiff, getObjectDiff, getObjectNumbers, getObjects, getObjectsToRemove, getOriginalDocument, getPageName, getPageReference, getPageReferenceWithLocale, getParent, getParentDoc, getParentURL, getPrefixedFullName, getPreviousVersion, getRealLanguage, getRealLanguage, getRealLocale, getRecentRevisions, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContent, getRenderedContentDiff, getRenderedContentDiff, getRenderedContentDiff, getRenderedTitle, getRenderedTitle, getRevisionInfo, getRevisions, getRevisions, getSections, getSpace, getSpaceName, getStringValue, getStringValue, getStringValue, getStringValue, getSyntaxId, getTagsList, getTemplate, getTemplateDocumentReference, getTranslatedContent, getTranslatedContent, getTranslatedDocument, getTranslatedDocument, getTranslatedDocument, getTranslationList, getTranslationLocales, getUniqueLinkedEntities, getUniqueLinkedPages, getUniqueWikiLinkedPages, getURL, getURL, getURL, getURL, getURL, getVersion, getVersionHashCode, getVersioningStore, getWeb, getWikiName, getXClasses, getXMLContent, getXMLDiff, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObject, getXObjectProperty, getXObjects, getXObjects, getXObjectSize, getXObjectSize, getXObjectsToRemove, getxWikiClassXML, getxWikiObject, hasElement, hashCode, incrementVersion, initialize, insertText, is10Syntax, is10Syntax, isAdvancedContent, isContentDirty, isCreator, isCreator, isCurrentLocalUserPage, isCurrentUserCreator, isCurrentUserPage, isMetaDataDirty, isMinorEdit, isNew, isProgrammaticContent, isRestricted, loadAttachmentContent, loadAttachments, loadAttachmentsContent, loadAttachmentsContentSafe, loadDocumentArchive, merge, mergeXClass, mergeXObjects, mergexWikiClass, mergexWikiObjects, newDocument, newDocument, newDocument, newObject, newXObject, readAddedUpdatedAndRemovedObjectsFromForm, readDocMetaFromForm, readFromForm, readFromTemplate, readObjectsFromForm, readObjectsFromFormUpdateOrCreate, readTemporaryUploadedFiles, readTranslationMetaFromForm, removeAttachment, removeAttachment, removeLock, removeObject, removeObjects, removeXObject, removeXObjects, removeXObjects, rename, rename, rename, renameProperties, renameProperties, renderXDOM, resetArchive, resolveClassReference, restoreContext, saveAllAttachments, saveAllAttachments, saveAttachmentContent, saveAttachmentContent, saveAttachmentsContent, setAsContextDoc, setAttachment, setAttachment, setAttachmentList, setAuthor, setAuthorReference, setComment, setContent, setContent, setContentAuthor, setContentAuthorReference, setContentDirty, setContentUpdateDate, setCreationDate, setCreator, setCreatorReference, setCustomClass, setDatabase, setDate, setDBStringListValue, setDBStringListValue, setDefaultLanguage, setDefaultLocale, setDefaultTemplate, setDocumentArchive, setDocumentArchive, setDocumentReference, setElement, setElements, setFormat, setFromCache, setFullName, setFullName, setHidden, setId, setIntValue, setIntValue, setLanguage, setLargeStringValue, setLargeStringValue, setLocale, setLock, setMeta, setMetaDataDirty, setMinorEdit, setMinorEdit1, setMostRecent, setName, setNew, setObject, setOriginalDocument, setParent, setParentReference, setProperty, setProperty, setRCSVersion, setRestricted, setSpace, setStore, setStringListValue, setStringListValue, setStringValue, setStringValue, setSyntax, setSyntaxId, setTags, setTemplate, setTemplateDocumentReference, setTitle, setTranslation, setValidationScript, setVersion, setWeb, setWikiNode, setXClass, setXClassXML, setXObject, setXObject, setXObjects, setXObjects, setXObjectsToRemove, setxWikiClassXML, toFullXML, toString, toXML, toXML, toXML, toXML, toXML, toXML, toXMLDocument, updateDocumentSection, updateObjectFromRequest, updateObjectFromRequest, updateObjectFromRequest, updateObjectsFromRequest, updateObjectsFromRequest, updateXObjectFromRequest, updateXObjectFromRequest, updateXObjectFromRequest, updateXObjectsFromRequest, updateXObjectsFromRequest, validate, validate

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

- Constructor Detail
  - LazyXWikiDocument
```
@Deprecated
public LazyXWikiDocument()
```
    Deprecated.
    use LazyXWikiDocument(DocumentReference) instead
  - LazyXWikiDocument
```
public LazyXWikiDocument(DocumentReference documentReference)
```
- Method Detail
  - getRCSVersion
```
public org.suigeneris.jrcs.rcs.Version getRCSVersion()
```
    Overrides:
    
    getRCSVersion in class XWikiDocument
  - getContent
```
public String getContent()
```
    Specified by:
    
    getContent in interface DocumentModelBridge
    
    Overrides:
    
    getContent in class XWikiDocument
  - getXObjects
```
public Map<DocumentReference,List<BaseObject>> getXObjects()
```
    Overrides:
    
    getXObjects in class XWikiDocument
  - getXClass
```
public BaseClass getXClass()
```
    Overrides:
    
    getXClass in class XWikiDocument
  - getXClassXML
```
public String getXClassXML()
```
    Overrides:
    
    getXClassXML in class XWikiDocument
  - getAuthorReference
```
public DocumentReference getAuthorReference()
```
    Overrides:
    
    getAuthorReference in class XWikiDocument
  - getContentAuthorReference
```
public DocumentReference getContentAuthorReference()
```
    Specified by:
    
    getContentAuthorReference in interface DocumentModelBridge
    
    Overrides:
    
    getContentAuthorReference in class XWikiDocument
  - getCreatorReference
```
public DocumentReference getCreatorReference()
```
    Overrides:
    
    getCreatorReference in class XWikiDocument
  - getDate
```
public Date getDate()
```
    Specified by:
    
    getDate in interface DocumentModelBridge
    
    Overrides:
    
    getDate in class XWikiDocument
  - getCreationDate
```
public Date getCreationDate()
```
    Specified by:
    
    getCreationDate in interface DocumentModelBridge
    
    Overrides:
    
    getCreationDate in class XWikiDocument
  - getContentUpdateDate
```
public Date getContentUpdateDate()
```
    Overrides:
    
    getContentUpdateDate in class XWikiDocument
  - getMeta
```
public String getMeta()
```
    Overrides:
    
    getMeta in class XWikiDocument
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface DocumentModelBridge
    
    Overrides:
    
    getTitle in class XWikiDocument
  - getFormat
```
public String getFormat()
```
    Overrides:
    
    getFormat in class XWikiDocument
  - getDefaultLocale
```
public Locale getDefaultLocale()
```
    Overrides:
    
    getDefaultLocale in class XWikiDocument
  - getTranslation
```
public int getTranslation()
```
    Overrides:
    
    getTranslation in class XWikiDocument
  - getCustomClass
```
public String getCustomClass()
```
    Overrides:
    
    getCustomClass in class XWikiDocument
  - getRelativeParentReference
```
public EntityReference getRelativeParentReference()
```
    Description copied from class: XWikiDocument
    
    Return the reference of the parent document as it stored and passed to XWikiDocument.setParentReference(EntityReference).
    You should use XWikiDocument.getParentReference() reference if you want the complete parent reference.
    
    Overrides:
    
    getRelativeParentReference in class XWikiDocument
    
    Returns:
    
    the relative parent reference
  - getParentReference
```
public DocumentReference getParentReference()
```
    Overrides:
    
    getParentReference in class XWikiDocument
    
    Returns:
    
    the parent reference or null if the parent is not set
  - getElements
```
public int getElements()
```
    Overrides:
    
    getElements in class XWikiDocument
  - getDefaultTemplate
```
public String getDefaultTemplate()
```
    Overrides:
    
    getDefaultTemplate in class XWikiDocument
  - getValidationScript
```
public String getValidationScript()
```
    Overrides:
    
    getValidationScript in class XWikiDocument
  - getComment
```
public String getComment()
```
    Overrides:
    
    getComment in class XWikiDocument
  - getSyntax
```
public org.xwiki.rendering.syntax.Syntax getSyntax()
```
    Specified by:
    
    getSyntax in interface DocumentModelBridge
    
    Overrides:
    
    getSyntax in class XWikiDocument
    
    Returns:
    
    the syntax of the document
  - isHidden
```
public Boolean isHidden()
```
    Description copied from class: XWikiDocument
    
    Indicates whether the document is 'hidden' or not, meaning that it should not be returned in public search results.
    
    Specified by:
    
    isHidden in interface DocumentModelBridge
    
    Overrides:
    
    isHidden in class XWikiDocument
    
    Returns:
    
    true if the document is hidden and does not appear among the results of XWiki.searchDocuments(String), false otherwise.
  - getDocumentArchive
```
public XWikiDocumentArchive getDocumentArchive()
```
    Overrides:
    
    getDocumentArchive in class XWikiDocument
    
    Returns:
    
    the XWikiDocumentArchive for this document. If it is not stored in the document, null is returned.
  - loadArchive
```
public void loadArchive(XWikiContext context)
                 throws XWikiException
```
    Overrides:
    
    loadArchive in class XWikiDocument
    
    Throws:
    
    XWikiException
  - getDocumentArchive
```
public XWikiDocumentArchive getDocumentArchive(XWikiContext context)
                                        throws XWikiException
```
    Overrides:
    
    getDocumentArchive in class XWikiDocument
    
    Throws:
    
    XWikiException
  - getStore
```
public XWikiStoreInterface getStore()
```
    Overrides:
    
    getStore in class XWikiDocument
  - getId
```
public long getId()
```
    Overrides:
    
    getId in class XWikiDocument
    
    Returns:
    
    the unique id used to represent the document, as a number. This id is technical and is equivalent to the Document Reference + the language of the Document. This technical id should only be used for the storage layer and all user APIs should instead use Document Reference and language as they are model-related while the id isn't (it's purely technical).
  - getStore
```
public XWikiStoreInterface getStore(XWikiContext context)
```
    Overrides:
    
    getStore in class XWikiDocument
  - getXDOM
```
public org.xwiki.rendering.block.XDOM getXDOM()
```
    Description copied from class: XWikiDocument
    
    NOTE: This method caches the XDOM and returns a clone that can be safely modified.
    
    Specified by:
    
    getXDOM in interface DocumentModelBridge
    
    Overrides:
    
    getXDOM in class XWikiDocument
    
    Returns:
    
    the XDOM corresponding to the document's string content
  - getTags
```
public String getTags(XWikiContext context)
```
    Overrides:
    
    getTags in class XWikiDocument
  - getTagsPossibleValues
```
public List<String> getTagsPossibleValues(XWikiContext context)
```
    Overrides:
    
    getTagsPossibleValues in class XWikiDocument
  - isFromCache
```
public boolean isFromCache()
```
    Overrides:
    
    isFromCache in class XWikiDocument
  - isMostRecent
```
public boolean isMostRecent()
```
    Overrides:
    
    isMostRecent in class XWikiDocument
    
    Returns:
    
    Is this version the most recent one. False if and only if there are newer versions of this document in the database.
  - toXMLDocument
```
public org.dom4j.Document toXMLDocument(boolean bWithObjects,
                                        boolean bWithRendering,
                                        boolean bWithAttachmentContent,
                                        boolean bWithVersions,
                                        XWikiContext context)
                                 throws XWikiException
```
    Description copied from class: XWikiDocument
    
    Serialize the document to an XML DOMDocument. You should prefer XWikiDocument.toXML(OutputStream, boolean, boolean, boolean, boolean, XWikiContext) or XWikiDocument.toXML(com.xpn.xwiki.internal.xml.XMLWriter, boolean, boolean, boolean, boolean, XWikiContext) when possible to reduce memory load.
    
    Overrides:
    
    toXMLDocument in class XWikiDocument
    
    Parameters:
    
    bWithObjects - include XObjects
    
    bWithRendering - include the rendered content
    
    bWithAttachmentContent - include attachments content
    
    bWithVersions - include archived versions
    
    context - current XWikiContext
    
    Returns:
    
    a DOMDocument containing the serialized document.
    
    Throws:
    
    XWikiException - when an errors occurs during wiki operations
  - getWikiNode
```
public Object getWikiNode()
```
    Overrides:
    
    getWikiNode in class XWikiDocument

Constructor	Description
`LazyXWikiDocument()`	Deprecated. use `LazyXWikiDocument(DocumentReference)` instead
`LazyXWikiDocument(DocumentReference documentReference)`

Class LazyXWikiDocument

Nested Class Summary

Nested classes/interfaces inherited from class com.xpn.xwiki.doc.XWikiDocument

Field Summary

Fields inherited from class com.xpn.xwiki.doc.XWikiDocument

Constructor Summary

Method Summary

Methods inherited from class com.xpn.xwiki.doc.XWikiDocument

Methods inherited from class java.lang.Object

Constructor Detail

LazyXWikiDocument

LazyXWikiDocument

Method Detail

getRCSVersion

getContent

getXObjects

getXClass

getXClassXML

getAuthorReference

getContentAuthorReference

getCreatorReference

getDate

getCreationDate

getContentUpdateDate

getMeta

getTitle

getFormat

getDefaultLocale

getTranslation

getCustomClass

getRelativeParentReference

getParentReference

getElements

getDefaultTemplate

getValidationScript

getComment

getSyntax

isHidden

getDocumentArchive

loadArchive

getDocumentArchive

getStore

getId

getStore

getXDOM

getTags

getTagsPossibleValues

isFromCache

isMostRecent

toXMLDocument

getWikiNode