com.xpn.xwiki.doc
Class XWikiDocument

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

All Implemented Interfaces:

DocumentModelBridge

public class XWikiDocument
extends java.lang.Object
implements DocumentModelBridge

Field Summary

static java.lang.String	DB_SPACE_SEP Separator string between database name and space name.
static int	HAS_ATTACHMENTS
static int	HAS_CLASS
static int	HAS_OBJECTS
static java.lang.String	SPACE_NAME_SEP Separator string between space name and page name.

Constructor Summary

XWikiDocument()

XWikiDocument(java.lang.String space, java.lang.String name)
Constructor that specifies the local document identifier: space name, document name.

XWikiDocument(java.lang.String wiki, java.lang.String web, java.lang.String name)
Constructor that specifies the full document identifier: wiki name, space name, document name.

Method Summary

XWikiAttachment	addAttachment(java.lang.String fileName, byte[] data, XWikiContext context)
XWikiAttachment	addAttachment(java.lang.String fileName, java.io.InputStream iStream, XWikiContext context)
void	addObject(java.lang.String classname, BaseObject object)
BaseObject	addObjectFromRequest(java.lang.String className, int num, XWikiContext context)
BaseObject	addObjectFromRequest(java.lang.String className, java.lang.String prefix, int num, XWikiContext context)
BaseObject	addObjectFromRequest(java.lang.String className, java.lang.String prefix, XWikiContext context)
BaseObject	addObjectFromRequest(java.lang.String className, XWikiContext context)
BaseObject	addObjectFromRequest(XWikiContext context)
java.util.List<BaseObject>	addObjectsFromRequest(java.lang.String className, java.lang.String pref, XWikiContext context)
java.util.List<BaseObject>	addObjectsFromRequest(java.lang.String className, XWikiContext context)
void	addObjectsToRemove(BaseObject object)
void	addToZip(java.util.zip.ZipOutputStream zos, boolean withVersions, XWikiContext context)
void	addToZip(java.util.zip.ZipOutputStream zos, XWikiContext context)
void	appendMeta(java.lang.String meta)
static void	backupContext(java.util.HashMap<java.lang.String,java.lang.Object> backup, XWikiContext context)
java.lang.Object	clone()
void	clonexWikiObjects(XWikiDocument templatedoc)
static boolean	containsXMLWikiDocument(org.dom4j.Document domdoc) Check if provided xml document is a wiki document.
void	copyAttachments(XWikiDocument xWikiSourceDocument)
XWikiDocument	copyDocument(java.lang.String newDocumentName, XWikiContext context)
int	createNewObject(java.lang.String classname, XWikiContext context)
void	deleteAttachment(XWikiAttachment attachment, boolean toRecycleBin, XWikiContext context)
void	deleteAttachment(XWikiAttachment attachment, XWikiContext context)
java.lang.String	display(java.lang.String fieldname, BaseObject obj, XWikiContext context)
java.lang.String	display(java.lang.String fieldname, java.lang.String type, BaseObject obj, XWikiContext context)
java.lang.String	display(java.lang.String fieldname, java.lang.String type, java.lang.String pref, BaseObject obj, XWikiContext context)
java.lang.String	display(java.lang.String fieldname, java.lang.String mode, java.lang.String prefix, XWikiContext context)
java.lang.String	display(java.lang.String fieldname, java.lang.String mode, XWikiContext context)
java.lang.String	display(java.lang.String fieldname, XWikiContext context)
java.lang.String	displayEdit(PropertyClass pclass, java.lang.String prefix, BaseCollection object, XWikiContext context)
java.lang.String	displayForm(java.lang.String className, java.lang.String header, java.lang.String format, boolean linebreak, XWikiContext context)
java.lang.String	displayForm(java.lang.String className, java.lang.String header, java.lang.String format, XWikiContext context)
java.lang.String	displayForm(java.lang.String className, XWikiContext context)
java.lang.String	displayHidden(PropertyClass pclass, java.lang.String prefix, BaseCollection object, XWikiContext context)
java.lang.String	displayPrettyName(java.lang.String fieldname, BaseObject obj, XWikiContext context)
java.lang.String	displayPrettyName(java.lang.String fieldname, boolean showMandatory, BaseObject obj, XWikiContext context)
java.lang.String	displayPrettyName(java.lang.String fieldname, boolean showMandatory, boolean before, BaseObject obj, XWikiContext context)
java.lang.String	displayPrettyName(java.lang.String fieldname, boolean showMandatory, boolean before, XWikiContext context)
java.lang.String	displayPrettyName(java.lang.String fieldname, boolean showMandatory, XWikiContext context)
java.lang.String	displayPrettyName(java.lang.String fieldname, XWikiContext context)
java.lang.String	displayRendered(PropertyClass pclass, java.lang.String prefix, BaseCollection object, XWikiContext context)
java.lang.String	displaySearch(PropertyClass pclass, java.lang.String prefix, XWikiCriteria criteria, XWikiContext context)
java.lang.String	displayTooltip(java.lang.String fieldname, BaseObject obj, XWikiContext context)
java.lang.String	displayTooltip(java.lang.String fieldname, XWikiContext context)
java.lang.String	displayView(PropertyClass pclass, java.lang.String prefix, BaseCollection object, XWikiContext context)
protected java.lang.String	encodedXMLStringAsUTF8(java.lang.String xmlString)
boolean	equals(java.lang.Object object)
java.lang.String	extractTitle()
void	fromXML(org.dom4j.Document domdoc, boolean withArchive)
void	fromXML(java.io.InputStream is)
void	fromXML(java.io.InputStream in, boolean withArchive)
void	fromXML(java.lang.String xml)
void	fromXML(java.lang.String xml, boolean withArchive)
XWikiAttachment	getAttachment(java.lang.String filename)
java.util.List<AttachmentDiff>	getAttachmentDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
java.util.List<XWikiAttachment>	getAttachmentList()
java.lang.String	getAttachmentRevisionURL(java.lang.String filename, java.lang.String revision, java.lang.String querystring, XWikiContext context)
java.lang.String	getAttachmentRevisionURL(java.lang.String filename, java.lang.String revision, XWikiContext context)
XWikiAttachmentStoreInterface	getAttachmentStore(XWikiContext context)
java.lang.String	getAttachmentURL(java.lang.String filename, java.lang.String action, java.lang.String querystring, XWikiContext context)
java.lang.String	getAttachmentURL(java.lang.String filename, java.lang.String action, XWikiContext context)
java.lang.String	getAttachmentURL(java.lang.String filename, XWikiContext context)
java.lang.String	getAuthor()
java.util.List	getBacklinks(XWikiContext context)
java.util.List<java.util.List<ObjectDiff>>	getClassDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
java.lang.String	getComment()
java.util.Vector<BaseObject>	getComments()
java.util.Vector<BaseObject>	getComments(boolean asc)
java.lang.String	getContent()
java.lang.String	getContentAuthor()
java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getContentDiff(java.lang.String fromRev, java.lang.String toRev, XWikiContext context)
java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getContentDiff(java.lang.String fromRev, XWikiContext context)
java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getContentDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
java.lang.String	getContentOfSection(int sectionNumber)
java.util.Date	getContentUpdateDate()
java.util.Date	getCreationDate()
java.lang.String	getCreator()
java.lang.String	getCustomClass()
java.lang.String	getDatabase()
java.util.Date	getDate()
java.lang.String	getDefaultEditURL(XWikiContext context)
java.lang.String	getDefaultLanguage()
java.lang.String	getDefaultTemplate()
protected java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getDeltas(org.suigeneris.jrcs.diff.Revision rev)
java.lang.String	getDisplayTitle(XWikiContext context)
XWikiDocumentArchive	getDocumentArchive()
XWikiDocumentArchive	getDocumentArchive(XWikiContext context)
DocumentSection	getDocumentSection(int sectionNumber)
java.lang.String	getEditURL(java.lang.String action, java.lang.String mode, java.lang.String language, XWikiContext context)
java.lang.String	getEditURL(java.lang.String action, java.lang.String mode, XWikiContext context)
protected java.lang.String	getElement(org.dom4j.Element docel, java.lang.String name)
int	getElements()
java.lang.String	getEscapedContent(XWikiContext context)
java.lang.String	getExternalAttachmentURL(java.lang.String filename, java.lang.String action, XWikiContext context)
java.lang.String	getExternalURL(java.lang.String action, java.lang.String querystring, XWikiContext context)
java.lang.String	getExternalURL(java.lang.String action, XWikiContext context)
BaseObject	getFirstObject(java.lang.String fieldname)
BaseObject	getFirstObject(java.lang.String fieldname, XWikiContext context)
java.lang.String	getFormat()
java.lang.String	getFullName()
long	getId()
java.util.List<java.lang.String>	getIncludedMacros(XWikiContext context)
java.util.List<java.lang.String>	getIncludedPages(XWikiContext context)
java.lang.String	getInternalProperty(java.lang.String propname)
static java.lang.String	getInternalPropertyName(java.lang.String propname, XWikiContext context)
int	getIntValue(java.lang.String fieldName)
int	getIntValue(java.lang.String className, java.lang.String fieldName)
java.lang.String	getLanguage()
java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getLastChanges(XWikiContext context)
java.util.List<java.lang.String>	getLinkedPages(XWikiContext context)
java.util.List	getLinks(XWikiContext context)
java.util.List	getListValue(java.lang.String fieldName)
java.util.List	getListValue(java.lang.String className, java.lang.String fieldName)
XWikiLock	getLock(XWikiContext context)
long	getLongValue(java.lang.String fieldName)
long	getLongValue(java.lang.String className, java.lang.String fieldName)
java.lang.String	getMeta()
java.util.List<MetaDataDiff>	getMetaDataDiff(java.lang.String fromRev, java.lang.String toRev, XWikiContext context)
java.util.List<MetaDataDiff>	getMetaDataDiff(java.lang.String fromRev, XWikiContext context)
java.util.List<MetaDataDiff>	getMetaDataDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
protected java.lang.Boolean	getMinorEdit1()
java.lang.String	getName()
BaseObject	getObject(java.lang.String classname)
BaseObject	getObject(java.lang.String classname, boolean create, XWikiContext context)
BaseObject	getObject(java.lang.String classname, int nb)
BaseObject	getObject(java.lang.String classname, java.lang.String key, java.lang.String value)
BaseObject	getObject(java.lang.String classname, java.lang.String key, java.lang.String value, boolean failover)
java.util.List<java.util.List<ObjectDiff>>	getObjectDiff(java.lang.String fromRev, java.lang.String toRev, XWikiContext context)
java.util.List<java.util.List<ObjectDiff>>	getObjectDiff(java.lang.String fromRev, XWikiContext context)
java.util.List<java.util.List<ObjectDiff>>	getObjectDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context) Return the object differences between two document versions.
int	getObjectNumbers(java.lang.String classname)
java.util.Vector<BaseObject>	getObjects(java.lang.String classname)
java.util.ArrayList<BaseObject>	getObjectsToRemove()
XWikiDocument	getOriginalDocument()
java.lang.String	getParent()
XWikiDocument	getParentDoc()
java.lang.String	getParentURL(XWikiContext context)
java.lang.String	getPreviousVersion()
org.suigeneris.jrcs.rcs.Version	getRCSVersion()
java.lang.String	getRealLanguage()
java.lang.String	getRealLanguage(XWikiContext context)
java.lang.String[]	getRecentRevisions(int nb, XWikiContext context)
java.lang.String	getRenderedContent(java.lang.String text, java.lang.String syntaxId, XWikiContext context)
java.lang.String	getRenderedContent(java.lang.String text, XWikiContext context) Deprecated. since 1.6M1 use getRenderedContent(String, String, com.xpn.xwiki.XWikiContext)
java.lang.String	getRenderedContent(XWikiContext context)
java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getRenderedContentDiff(java.lang.String fromRev, java.lang.String toRev, XWikiContext context)
java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getRenderedContentDiff(java.lang.String fromRev, XWikiContext context)
java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getRenderedContentDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
XWikiRCSNodeInfo	getRevisionInfo(java.lang.String version, XWikiContext context)
java.util.List<java.lang.String>	getRevisions(RevisionCriteria criteria, XWikiContext context) Get document versions matching criterias like author, minimum creation date, etc.
org.suigeneris.jrcs.rcs.Version[]	getRevisions(XWikiContext context)
java.util.List<DocumentSection>	getSections()
java.lang.String	getSpace()
java.util.List<DocumentSection>	getSplitSectionsAccordingToTitle() Deprecated. use getSections() instead, since 1.6M1
XWikiStoreInterface	getStore()
XWikiStoreInterface	getStore(XWikiContext context)
java.lang.String	getStringValue(java.lang.String fieldName)
java.lang.String	getStringValue(java.lang.String className, java.lang.String fieldName)
java.lang.String	getSyntaxId()
java.lang.String	getTags(XWikiContext context)
java.util.List	getTagsList(XWikiContext context)
java.util.List	getTagsPossibleValues(XWikiContext context)
java.lang.String	getTemplate()
java.lang.String	getTitle()
java.lang.String	getTranslatedContent(java.lang.String language, XWikiContext context)
java.lang.String	getTranslatedContent(XWikiContext context)
XWikiDocument	getTranslatedDocument(java.lang.String language, XWikiContext context)
XWikiDocument	getTranslatedDocument(XWikiContext context)
int	getTranslation()
java.util.List<java.lang.String>	getTranslationList(XWikiContext context)
java.lang.String	getURL(java.lang.String action, boolean redirect, XWikiContext context)
java.lang.String	getURL(java.lang.String action, java.lang.String params, boolean redirect, XWikiContext context)
java.lang.String	getURL(java.lang.String action, java.lang.String querystring, java.lang.String anchor, XWikiContext context)
java.lang.String	getURL(java.lang.String action, java.lang.String querystring, XWikiContext context)
java.lang.String	getURL(java.lang.String action, XWikiContext context)
java.lang.String	getValidationScript()
java.lang.String	getVersion()
java.lang.String	getVersionHashCode(XWikiContext context) Computes a document hash, taking into account all document data: content, objects, attachments, metadata...
XWikiVersioningStoreInterface	getVersioningStore(XWikiContext context)
java.lang.String	getWikiName()
java.lang.Object	getWikiNode()
java.lang.String	getXMLContent(XWikiContext context)
java.util.List<org.suigeneris.jrcs.diff.delta.Delta>	getXMLDiff(XWikiDocument fromDoc, XWikiDocument toDoc, XWikiContext context)
BaseClass	getxWikiClass()
java.util.List<BaseClass>	getxWikiClasses(XWikiContext context)
java.lang.String	getxWikiClassXML()
BaseObject	getxWikiObject()
java.util.Map<java.lang.String,java.util.Vector<BaseObject>>	getxWikiObjects()
boolean	hasElement(int element)
void	incrementVersion()
void	insertText(java.lang.String text, java.lang.String marker, XWikiContext context)
boolean	isAdvancedContent()
boolean	isContentDirty()
boolean	isCreator(java.lang.String username)
boolean	isCurrentLocalUserPage(XWikiContext context)
boolean	isCurrentUserCreator(XWikiContext context)
boolean	isCurrentUserPage(XWikiContext context)
boolean	isFromCache()
java.lang.Boolean	isHidden() Indicates whether the document is 'hidden' or not, meaning that it should not be returned in public search results.
boolean	isMetaDataDirty()
boolean	isMinorEdit()
boolean	isMostRecent()
boolean	isNew()
boolean	isProgrammaticContent()
void	loadArchive(XWikiContext context)
void	loadAttachmentContent(XWikiAttachment attachment, XWikiContext context)
void	loadAttachments(XWikiContext context)
void	mergexWikiClass(XWikiDocument templatedoc)
void	mergexWikiObjects(XWikiDocument templatedoc)
Document	newDocument(java.lang.Class<?> customClass, XWikiContext context) Create a new protected Document public API to access page information and actions from scripting.
Document	newDocument(java.lang.String customClassName, XWikiContext context) Create a new protected Document public API to access page information and actions from scripting.
Document	newDocument(XWikiContext context)
BaseObject	newObject(java.lang.String classname, XWikiContext context)
void	notify(XWikiNotificationRule rule, XWikiDocument newdoc, XWikiDocument olddoc, int event, XWikiContext context)
void	readDocMetaFromForm(EditForm eform, XWikiContext context)
void	readFromForm(EditForm eform, XWikiContext context)
void	readFromTemplate(EditForm eform, XWikiContext context)
void	readFromTemplate(java.lang.String template, XWikiContext context)
void	readObjectsFromForm(EditForm eform, XWikiContext context)
void	readTranslationMetaFromForm(EditForm eform, XWikiContext context)
void	removeLock(XWikiContext context)
boolean	removeObject(BaseObject bobj)
boolean	removeObjects(java.lang.String className) Remove all the objects of a given type (XClass) from the document.
void	rename(java.lang.String newDocumentName, java.util.List<java.lang.String> backlinkDocumentNames, XWikiContext context) Rename the current document and all the links pointing to it in the list of passed backlink documents.
void	rename(java.lang.String newDocumentName, XWikiContext context) Rename the current document and all the backlinks leading to it.
void	renameProperties(java.lang.String className, java.util.Map fieldsToRename)
void	resetArchive(XWikiContext context)
static void	restoreContext(java.util.HashMap<java.lang.String,java.lang.Object> backup, XWikiContext context)
void	saveAllAttachments(boolean updateParent, boolean transaction, XWikiContext context)
void	saveAllAttachments(XWikiContext context)
protected void	saveAttachmentContent(XWikiAttachment attachment, boolean bParentUpdate, boolean bTransaction, XWikiContext context)
void	saveAttachmentContent(XWikiAttachment attachment, XWikiContext context)
void	saveAttachmentsContent(java.util.List<XWikiAttachment> attachments, XWikiContext context)
void	setAsContextDoc(XWikiContext context)
void	setAttachmentList(java.util.List<XWikiAttachment> list)
void	setAuthor(java.lang.String author)
void	setComment(java.lang.String comment)
void	setContent(java.lang.String content)
void	setContentAuthor(java.lang.String contentAuthor)
void	setContentDirty(boolean contentDirty)
void	setContentUpdateDate(java.util.Date date)
void	setCreationDate(java.util.Date date)
void	setCreator(java.lang.String creator)
void	setCustomClass(java.lang.String customClass)
void	setDatabase(java.lang.String database)
void	setDate(java.util.Date date)
void	setDBStringListValue(java.lang.String className, java.lang.String fieldName, java.util.List value)
void	setDefaultLanguage(java.lang.String defaultLanguage)
void	setDefaultTemplate(java.lang.String defaultTemplate)
void	setDocumentArchive(java.lang.String sarch)
void	setDocumentArchive(XWikiDocumentArchive arch)
void	setElement(int element, boolean toggle)
void	setElements(int elements)
void	setFormat(java.lang.String format)
void	setFromCache(boolean fromCache)
void	setFullName(java.lang.String name)
void	setFullName(java.lang.String fullname, XWikiContext context)
void	setHidden(java.lang.Boolean hidden) Indicates whether the document should be 'hidden' or not, meaning that it should not be returned in public search results.
void	setId(long id)
void	setIntValue(java.lang.String className, java.lang.String fieldName, int value)
void	setLanguage(java.lang.String language)
void	setLargeStringValue(java.lang.String className, java.lang.String fieldName, java.lang.String value)
void	setLock(java.lang.String userName, XWikiContext context)
void	setMeta(java.lang.String meta)
void	setMetaDataDirty(boolean metaDataDirty)
void	setMinorEdit(boolean isMinor)
protected void	setMinorEdit1(java.lang.Boolean isMinor)
void	setMostRecent(boolean mostRecent) must not be used unless in store system.
void	setName(java.lang.String name)
void	setNew(boolean aNew)
void	setObject(java.lang.String classname, int nb, BaseObject object)
void	setObjects(java.lang.String classname, java.util.Vector<BaseObject> objects)
void	setObjectsToRemove(java.util.ArrayList<BaseObject> objectsToRemove)
void	setOriginalDocument(XWikiDocument originalDocument)
void	setParent(java.lang.String parent)
void	setProperty(java.lang.String className, java.lang.String fieldName, BaseProperty value)
void	setRCSVersion(org.suigeneris.jrcs.rcs.Version version)
void	setSpace(java.lang.String space)
void	setStore(XWikiStoreInterface store)
void	setStringListValue(java.lang.String className, java.lang.String fieldName, java.util.List value)
void	setStringValue(java.lang.String className, java.lang.String fieldName, java.lang.String value)
void	setSyntaxId(java.lang.String syntaxId)
void	setTags(java.lang.String tags, XWikiContext context) add tags to the document.
void	setTemplate(java.lang.String template)
void	setTitle(java.lang.String title)
void	setTranslation(int translation)
void	setValidationScript(java.lang.String validationScript)
void	setVersion(java.lang.String version)
void	setWikiNode(java.lang.Object wikiNode)
void	setxWikiClass(BaseClass xWikiClass)
void	setxWikiClassXML(java.lang.String xWikiClassXML)
void	setxWikiObjects(java.util.Map<java.lang.String,java.util.Vector<BaseObject>> xWikiObjects)
java.lang.String	toFullXML(XWikiContext context)
java.lang.String	toString()
java.lang.String	toXML(boolean bWithObjects, boolean bWithRendering, boolean bWithAttachmentContent, boolean bWithVersions, XWikiContext context)
java.lang.String	toXML(org.dom4j.Document doc, XWikiContext context)
java.lang.String	toXML(XWikiContext context)
org.dom4j.Document	toXMLDocument(boolean bWithObjects, boolean bWithRendering, boolean bWithAttachmentContent, boolean bWithVersions, XWikiContext context)
org.dom4j.Document	toXMLDocument(XWikiContext context)
java.lang.String	updateDocumentSection(int sectionNumber, java.lang.String newSectionContent)
BaseObject	updateObjectFromRequest(java.lang.String className, java.lang.String prefix, int num, XWikiContext context)
BaseObject	updateObjectFromRequest(java.lang.String className, java.lang.String prefix, XWikiContext context)
BaseObject	updateObjectFromRequest(java.lang.String className, XWikiContext context)
java.util.List<BaseObject>	updateObjectsFromRequest(java.lang.String className, java.lang.String pref, XWikiContext context)
java.util.List	updateObjectsFromRequest(java.lang.String className, XWikiContext context)
boolean	validate(java.lang.String[] classNames, XWikiContext context)
boolean	validate(XWikiContext context)

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HAS_ATTACHMENTS

public static final int HAS_ATTACHMENTS

See Also:

Constant Field Values

HAS_OBJECTS

public static final int HAS_OBJECTS

See Also:

Constant Field Values

HAS_CLASS

public static final int HAS_CLASS

See Also:

Constant Field Values

DB_SPACE_SEP

public static final java.lang.String DB_SPACE_SEP

Separator string between database name and space name.

See Also:

Constant Field Values

SPACE_NAME_SEP

public static final java.lang.String SPACE_NAME_SEP

Separator string between space name and page name.

See Also:

Constant Field Values

Constructor Detail

XWikiDocument

public XWikiDocument()

XWikiDocument

public XWikiDocument(java.lang.String space,
                     java.lang.String name)

Constructor that specifies the local document identifier: space name, document name. setDatabase(String) must be called afterwards to specify the wiki name.

Parameters:

web - The space this document belongs to.

name - The name of the document.

XWikiDocument

public XWikiDocument(java.lang.String wiki,
                     java.lang.String web,
                     java.lang.String name)

Constructor that specifies the full document identifier: wiki name, space name, document name.

Parameters:

wiki - The wiki this document belongs to.

web - The space this document belongs to.

name - The name of the document.

Method Detail

getStore

public XWikiStoreInterface getStore(XWikiContext context)

getAttachmentStore

public XWikiAttachmentStoreInterface getAttachmentStore(XWikiContext context)

getVersioningStore

public XWikiVersioningStoreInterface getVersioningStore(XWikiContext context)

getStore

public XWikiStoreInterface getStore()

setStore

public void setStore(XWikiStoreInterface store)

getId

public long getId()

setId

public void setId(long id)

getSpace

public java.lang.String getSpace()

Returns:

the name of the space of the document

setSpace

public void setSpace(java.lang.String space)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getRCSVersion

public org.suigeneris.jrcs.rcs.Version getRCSVersion()

setRCSVersion

public void setRCSVersion(org.suigeneris.jrcs.rcs.Version version)

getOriginalDocument

public XWikiDocument getOriginalDocument()

Specified by:

getOriginalDocument in interface DocumentModelBridge

Returns:

the copy of this XWikiDocument instance before any modification was made to it.

See Also:

originalDocument

setOriginalDocument

public void setOriginalDocument(XWikiDocument originalDocument)

Parameters:

originalDocument - the original document representing this document instance before any change was made to it, prior to the last time it was saved

See Also:

originalDocument

getParentDoc

public XWikiDocument getParentDoc()

getParent

public java.lang.String getParent()

setParent

public void setParent(java.lang.String parent)

getContent

public java.lang.String getContent()

Specified by:

getContent in interface DocumentModelBridge

setContent

public void setContent(java.lang.String content)

getRenderedContent

public java.lang.String getRenderedContent(XWikiContext context)
                                    throws XWikiException

Throws:

XWikiException

getRenderedContent

public java.lang.String getRenderedContent(java.lang.String text,
                                           java.lang.String syntaxId,
                                           XWikiContext context)

Parameters:

text - the text to render

syntaxId - the id of the Syntax used by the passed text (for example: "xwiki/1.0")

context - the XWiki Context object

Returns:

the given text rendered in the context of this document using the passed Syntax

Since:

1.6M1

getRenderedContent

@Deprecated
public java.lang.String getRenderedContent(java.lang.String text,
                                                      XWikiContext context)

Deprecated. since 1.6M1 use getRenderedContent(String, String, com.xpn.xwiki.XWikiContext)

Parameters:

text - the text to render

context - the XWiki Context object

Returns:

the given text rendered in the context of this document

getEscapedContent

public java.lang.String getEscapedContent(XWikiContext context)
                                   throws XWikiException

Throws:

XWikiException

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getFullName

public java.lang.String getFullName()

Specified by:

getFullName in interface DocumentModelBridge

setFullName

public void setFullName(java.lang.String name)

getWikiName

public java.lang.String getWikiName()

Specified by:

getWikiName in interface DocumentModelBridge

See Also:

DocumentModelBridge.getWikiName()

getTitle

public java.lang.String getTitle()

getDisplayTitle

public java.lang.String getDisplayTitle(XWikiContext context)

Parameters:

context - the XWiki context used to get acces to the XWikiRenderingEngine object

Returns:

the document title. If a title has not been provided, look for a section title in the document's content and if not found return the page name. The returned title is also interpreted which means it's allowed to use Velocity, Groovy, etc syntax within a title.

extractTitle

public java.lang.String extractTitle()

Returns:

the first level 1 or level 1.1 title text in the document's content or "" if none are found

setTitle

public void setTitle(java.lang.String title)

getFormat

public java.lang.String getFormat()

setFormat

public void setFormat(java.lang.String format)

getAuthor

public java.lang.String getAuthor()

getContentAuthor

public java.lang.String getContentAuthor()

setAuthor

public void setAuthor(java.lang.String author)

setContentAuthor

public void setContentAuthor(java.lang.String contentAuthor)

getCreator

public java.lang.String getCreator()

setCreator

public void setCreator(java.lang.String creator)

getDate

public java.util.Date getDate()

setDate

public void setDate(java.util.Date date)

getCreationDate

public java.util.Date getCreationDate()

setCreationDate

public void setCreationDate(java.util.Date date)

getContentUpdateDate

public java.util.Date getContentUpdateDate()

setContentUpdateDate

public void setContentUpdateDate(java.util.Date date)

getMeta

public java.lang.String getMeta()

setMeta

public void setMeta(java.lang.String meta)

appendMeta

public void appendMeta(java.lang.String meta)

isContentDirty

public boolean isContentDirty()

incrementVersion

public void incrementVersion()

setContentDirty

public void setContentDirty(boolean contentDirty)

isMetaDataDirty

public boolean isMetaDataDirty()

setMetaDataDirty

public void setMetaDataDirty(boolean metaDataDirty)

getAttachmentURL

public java.lang.String getAttachmentURL(java.lang.String filename,
                                         XWikiContext context)

getAttachmentURL

public java.lang.String getAttachmentURL(java.lang.String filename,
                                         java.lang.String action,
                                         XWikiContext context)

getExternalAttachmentURL

public java.lang.String getExternalAttachmentURL(java.lang.String filename,
                                                 java.lang.String action,
                                                 XWikiContext context)

getAttachmentURL

public java.lang.String getAttachmentURL(java.lang.String filename,
                                         java.lang.String action,
                                         java.lang.String querystring,
                                         XWikiContext context)

getAttachmentRevisionURL

public java.lang.String getAttachmentRevisionURL(java.lang.String filename,
                                                 java.lang.String revision,
                                                 XWikiContext context)

getAttachmentRevisionURL

public java.lang.String getAttachmentRevisionURL(java.lang.String filename,
                                                 java.lang.String revision,
                                                 java.lang.String querystring,
                                                 XWikiContext context)

getURL

public java.lang.String getURL(java.lang.String action,
                               java.lang.String params,
                               boolean redirect,
                               XWikiContext context)

getURL

public java.lang.String getURL(java.lang.String action,
                               boolean redirect,
                               XWikiContext context)

getURL

public java.lang.String getURL(java.lang.String action,
                               XWikiContext context)

getURL

public java.lang.String getURL(java.lang.String action,
                               java.lang.String querystring,
                               XWikiContext context)

getURL

public java.lang.String getURL(java.lang.String action,
                               java.lang.String querystring,
                               java.lang.String anchor,
                               XWikiContext context)

getExternalURL

public java.lang.String getExternalURL(java.lang.String action,
                                       XWikiContext context)

getExternalURL

public java.lang.String getExternalURL(java.lang.String action,
                                       java.lang.String querystring,
                                       XWikiContext context)

getParentURL

public java.lang.String getParentURL(XWikiContext context)
                              throws XWikiException

Throws:

XWikiException

getDocumentArchive

public XWikiDocumentArchive getDocumentArchive(XWikiContext context)
                                        throws XWikiException

Throws:

XWikiException

newDocument

public Document newDocument(java.lang.String customClassName,
                            XWikiContext context)

Create a new protected Document public API to access page information and actions from scripting.

Parameters:

customClassName - the name of the custom Document class of the object to create.

context - the XWiki context.

Returns:

a wrapped version of an XWikiDocument. Prefer this function instead of new Document(XWikiDocument, XWikiContext)

newDocument

public Document newDocument(java.lang.Class<?> customClass,
                            XWikiContext context)

Create a new protected Document public API to access page information and actions from scripting.

Parameters:

customClass - the custom Document class the object to create.

context - the XWiki context.

Returns:

a wrapped version of an XWikiDocument. Prefer this function instead of new Document(XWikiDocument, XWikiContext)

newDocument

public Document newDocument(XWikiContext context)

loadArchive

public void loadArchive(XWikiContext context)
                 throws XWikiException

Throws:

XWikiException

getDocumentArchive

public XWikiDocumentArchive getDocumentArchive()

setDocumentArchive

public void setDocumentArchive(XWikiDocumentArchive arch)

setDocumentArchive

public void setDocumentArchive(java.lang.String sarch)
                        throws XWikiException

Throws:

XWikiException

getRevisions

public org.suigeneris.jrcs.rcs.Version[] getRevisions(XWikiContext context)
                                               throws XWikiException

Throws:

XWikiException

getRecentRevisions

public java.lang.String[] getRecentRevisions(int nb,
                                             XWikiContext context)
                                      throws XWikiException

Throws:

XWikiException

getRevisions

public java.util.List<java.lang.String> getRevisions(RevisionCriteria criteria,
                                                     XWikiContext context)
                                              throws XWikiException

Get document versions matching criterias like author, minimum creation date, etc.

Parameters:

criteria - criteria used to match versions

Returns:

a list of matching versions

Throws:

XWikiException

getRevisionInfo

public XWikiRCSNodeInfo getRevisionInfo(java.lang.String version,
                                        XWikiContext context)
                                 throws XWikiException

Throws:

XWikiException

isMostRecent

public boolean isMostRecent()

Returns:

Is this version the most recent one. False if and only if there are newer versions of this document in the database.

setMostRecent

public void setMostRecent(boolean mostRecent)

must not be used unless in store system.

Parameters:

mostRecent - - mark document as most recent.

getxWikiClass

public BaseClass getxWikiClass()

setxWikiClass

public void setxWikiClass(BaseClass xWikiClass)

getxWikiObjects

public java.util.Map<java.lang.String,java.util.Vector<BaseObject>> getxWikiObjects()

setxWikiObjects

public void setxWikiObjects(java.util.Map<java.lang.String,java.util.Vector<BaseObject>> xWikiObjects)

getxWikiObject

public BaseObject getxWikiObject()

getxWikiClasses

public java.util.List<BaseClass> getxWikiClasses(XWikiContext context)

createNewObject

public int createNewObject(java.lang.String classname,
                           XWikiContext context)
                    throws XWikiException

Throws:

XWikiException

getObjectNumbers

public int getObjectNumbers(java.lang.String classname)

getObjects

public java.util.Vector<BaseObject> getObjects(java.lang.String classname)

setObjects

public void setObjects(java.lang.String classname,
                       java.util.Vector<BaseObject> objects)

getObject

public BaseObject getObject(java.lang.String classname)

getObject

public BaseObject getObject(java.lang.String classname,
                            int nb)

getObject

public BaseObject getObject(java.lang.String classname,
                            java.lang.String key,
                            java.lang.String value)

getObject

public BaseObject getObject(java.lang.String classname,
                            java.lang.String key,
                            java.lang.String value,
                            boolean failover)

addObject

public void addObject(java.lang.String classname,
                      BaseObject object)

setObject

public void setObject(java.lang.String classname,
                      int nb,
                      BaseObject object)

isNew

public boolean isNew()

Returns:

true if the document is a new one (ie it has never been saved) or false otherwise

setNew

public void setNew(boolean aNew)

mergexWikiClass

public void mergexWikiClass(XWikiDocument templatedoc)

mergexWikiObjects

public void mergexWikiObjects(XWikiDocument templatedoc)

clonexWikiObjects

public void clonexWikiObjects(XWikiDocument templatedoc)

getTemplate

public java.lang.String getTemplate()

setTemplate

public void setTemplate(java.lang.String template)

displayPrettyName

public java.lang.String displayPrettyName(java.lang.String fieldname,
                                          XWikiContext context)

displayPrettyName

public java.lang.String displayPrettyName(java.lang.String fieldname,
                                          boolean showMandatory,
                                          XWikiContext context)

displayPrettyName

public java.lang.String displayPrettyName(java.lang.String fieldname,
                                          boolean showMandatory,
                                          boolean before,
                                          XWikiContext context)

displayPrettyName

public java.lang.String displayPrettyName(java.lang.String fieldname,
                                          BaseObject obj,
                                          XWikiContext context)

displayPrettyName

public java.lang.String displayPrettyName(java.lang.String fieldname,
                                          boolean showMandatory,
                                          BaseObject obj,
                                          XWikiContext context)

displayPrettyName

public java.lang.String displayPrettyName(java.lang.String fieldname,
                                          boolean showMandatory,
                                          boolean before,
                                          BaseObject obj,
                                          XWikiContext context)

displayTooltip

public java.lang.String displayTooltip(java.lang.String fieldname,
                                       XWikiContext context)

displayTooltip

public java.lang.String displayTooltip(java.lang.String fieldname,
                                       BaseObject obj,
                                       XWikiContext context)

display

public java.lang.String display(java.lang.String fieldname,
                                java.lang.String type,
                                BaseObject obj,
                                XWikiContext context)

display

public java.lang.String display(java.lang.String fieldname,
                                java.lang.String type,
                                java.lang.String pref,
                                BaseObject obj,
                                XWikiContext context)

display

public java.lang.String display(java.lang.String fieldname,
                                BaseObject obj,
                                XWikiContext context)

display

public java.lang.String display(java.lang.String fieldname,
                                XWikiContext context)

display

public java.lang.String display(java.lang.String fieldname,
                                java.lang.String mode,
                                XWikiContext context)

display

public java.lang.String display(java.lang.String fieldname,
                                java.lang.String mode,
                                java.lang.String prefix,
                                XWikiContext context)

displayForm

public java.lang.String displayForm(java.lang.String className,
                                    java.lang.String header,
                                    java.lang.String format,
                                    XWikiContext context)

displayForm

public java.lang.String displayForm(java.lang.String className,
                                    java.lang.String header,
                                    java.lang.String format,
                                    boolean linebreak,
                                    XWikiContext context)

displayForm

public java.lang.String displayForm(java.lang.String className,
                                    XWikiContext context)

isFromCache

public boolean isFromCache()

setFromCache

public void setFromCache(boolean fromCache)

readDocMetaFromForm

public void readDocMetaFromForm(EditForm eform,
                                XWikiContext context)
                         throws XWikiException

Throws:

XWikiException

setTags

public void setTags(java.lang.String tags,
                    XWikiContext context)
             throws XWikiException

add tags to the document.

Throws:

XWikiException

getTags

public java.lang.String getTags(XWikiContext context)

getTagsList

public java.util.List getTagsList(XWikiContext context)

getTagsPossibleValues

public java.util.List getTagsPossibleValues(XWikiContext context)

readTranslationMetaFromForm

public void readTranslationMetaFromForm(EditForm eform,
                                        XWikiContext context)
                                 throws XWikiException

Throws:

XWikiException

readObjectsFromForm

public void readObjectsFromForm(EditForm eform,
                                XWikiContext context)
                         throws XWikiException

Throws:

XWikiException

readFromForm

public void readFromForm(EditForm eform,
                         XWikiContext context)
                  throws XWikiException

Throws:

XWikiException

readFromTemplate

public void readFromTemplate(EditForm eform,
                             XWikiContext context)
                      throws XWikiException

Throws:

XWikiException

readFromTemplate

public void readFromTemplate(java.lang.String template,
                             XWikiContext context)
                      throws XWikiException

Throws:

XWikiException

notify

public void notify(XWikiNotificationRule rule,
                   XWikiDocument newdoc,
                   XWikiDocument olddoc,
                   int event,
                   XWikiContext context)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

copyAttachments

public void copyAttachments(XWikiDocument xWikiSourceDocument)

loadAttachments

public void loadAttachments(XWikiContext context)
                     throws XWikiException

Throws:

XWikiException

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

toXML

public java.lang.String toXML(org.dom4j.Document doc,
                              XWikiContext context)

getXMLContent

public java.lang.String getXMLContent(XWikiContext context)
                               throws XWikiException

Throws:

XWikiException

toXML

public java.lang.String toXML(XWikiContext context)
                       throws XWikiException

Throws:

XWikiException

toFullXML

public java.lang.String toFullXML(XWikiContext context)
                           throws XWikiException

Throws:

XWikiException

addToZip

public void addToZip(java.util.zip.ZipOutputStream zos,
                     boolean withVersions,
                     XWikiContext context)
              throws java.io.IOException

Throws:

java.io.IOException

addToZip

public void addToZip(java.util.zip.ZipOutputStream zos,
                     XWikiContext context)
              throws java.io.IOException

Throws:

java.io.IOException

toXML

public java.lang.String toXML(boolean bWithObjects,
                              boolean bWithRendering,
                              boolean bWithAttachmentContent,
                              boolean bWithVersions,
                              XWikiContext context)
                       throws XWikiException

Throws:

XWikiException

toXMLDocument

public org.dom4j.Document toXMLDocument(XWikiContext context)
                                 throws XWikiException

Throws:

XWikiException

toXMLDocument

public org.dom4j.Document toXMLDocument(boolean bWithObjects,
                                        boolean bWithRendering,
                                        boolean bWithAttachmentContent,
                                        boolean bWithVersions,
                                        XWikiContext context)
                                 throws XWikiException

Throws:

XWikiException

encodedXMLStringAsUTF8

protected java.lang.String encodedXMLStringAsUTF8(java.lang.String xmlString)

getElement

protected java.lang.String getElement(org.dom4j.Element docel,
                                      java.lang.String name)

fromXML

public void fromXML(java.lang.String xml)
             throws XWikiException

Throws:

XWikiException

fromXML

public void fromXML(java.io.InputStream is)
             throws XWikiException

Throws:

XWikiException

fromXML

public void fromXML(java.lang.String xml,
                    boolean withArchive)
             throws XWikiException

Throws:

XWikiException

fromXML

public void fromXML(java.io.InputStream in,
                    boolean withArchive)
             throws XWikiException

Throws:

XWikiException

fromXML

public void fromXML(org.dom4j.Document domdoc,
                    boolean withArchive)
             throws XWikiException

Throws:

XWikiException

containsXMLWikiDocument

public static boolean containsXMLWikiDocument(org.dom4j.Document domdoc)

Check if provided xml document is a wiki document.

Parameters:

domdoc - the xml document.

Returns:

true if provided xml document is a wiki document.

setAttachmentList

public void setAttachmentList(java.util.List<XWikiAttachment> list)

getAttachmentList

public java.util.List<XWikiAttachment> getAttachmentList()

saveAllAttachments

public void saveAllAttachments(XWikiContext context)
                        throws XWikiException

Throws:

XWikiException

saveAllAttachments

public void saveAllAttachments(boolean updateParent,
                               boolean transaction,
                               XWikiContext context)
                        throws XWikiException

Throws:

XWikiException

saveAttachmentsContent

public void saveAttachmentsContent(java.util.List<XWikiAttachment> attachments,
                                   XWikiContext context)
                            throws XWikiException

Throws:

XWikiException

saveAttachmentContent

public void saveAttachmentContent(XWikiAttachment attachment,
                                  XWikiContext context)
                           throws XWikiException

Throws:

XWikiException

saveAttachmentContent

protected void saveAttachmentContent(XWikiAttachment attachment,
                                     boolean bParentUpdate,
                                     boolean bTransaction,
                                     XWikiContext context)
                              throws XWikiException

Throws:

XWikiException

loadAttachmentContent

public void loadAttachmentContent(XWikiAttachment attachment,
                                  XWikiContext context)
                           throws XWikiException

Throws:

XWikiException

deleteAttachment

public void deleteAttachment(XWikiAttachment attachment,
                             XWikiContext context)
                      throws XWikiException

Throws:

XWikiException

deleteAttachment

public void deleteAttachment(XWikiAttachment attachment,
                             boolean toRecycleBin,
                             XWikiContext context)
                      throws XWikiException

Throws:

XWikiException

getBacklinks

public java.util.List getBacklinks(XWikiContext context)
                            throws XWikiException

Throws:

XWikiException

getLinks

public java.util.List getLinks(XWikiContext context)
                        throws XWikiException

Throws:

XWikiException

renameProperties

public void renameProperties(java.lang.String className,
                             java.util.Map fieldsToRename)

addObjectsToRemove

public void addObjectsToRemove(BaseObject object)

getObjectsToRemove

public java.util.ArrayList<BaseObject> getObjectsToRemove()

setObjectsToRemove

public void setObjectsToRemove(java.util.ArrayList<BaseObject> objectsToRemove)

getIncludedPages

public java.util.List<java.lang.String> getIncludedPages(XWikiContext context)

getIncludedMacros

public java.util.List<java.lang.String> getIncludedMacros(XWikiContext context)

getLinkedPages

public java.util.List<java.lang.String> getLinkedPages(XWikiContext context)

displayRendered

public java.lang.String displayRendered(PropertyClass pclass,
                                        java.lang.String prefix,
                                        BaseCollection object,
                                        XWikiContext context)
                                 throws XWikiException

Throws:

XWikiException

displayView

public java.lang.String displayView(PropertyClass pclass,
                                    java.lang.String prefix,
                                    BaseCollection object,
                                    XWikiContext context)

displayEdit

public java.lang.String displayEdit(PropertyClass pclass,
                                    java.lang.String prefix,
                                    BaseCollection object,
                                    XWikiContext context)

displayHidden

public java.lang.String displayHidden(PropertyClass pclass,
                                      java.lang.String prefix,
                                      BaseCollection object,
                                      XWikiContext context)

displaySearch

public java.lang.String displaySearch(PropertyClass pclass,
                                      java.lang.String prefix,
                                      XWikiCriteria criteria,
                                      XWikiContext context)

getAttachment

public XWikiAttachment getAttachment(java.lang.String filename)

addAttachment

public XWikiAttachment addAttachment(java.lang.String fileName,
                                     java.io.InputStream iStream,
                                     XWikiContext context)
                              throws XWikiException,
                                     java.io.IOException

Throws:

XWikiException

java.io.IOException

addAttachment

public XWikiAttachment addAttachment(java.lang.String fileName,
                                     byte[] data,
                                     XWikiContext context)
                              throws XWikiException

Throws:

XWikiException

getFirstObject

public BaseObject getFirstObject(java.lang.String fieldname)

getFirstObject

public BaseObject getFirstObject(java.lang.String fieldname,
                                 XWikiContext context)

setProperty

public void setProperty(java.lang.String className,
                        java.lang.String fieldName,
                        BaseProperty value)

getIntValue

public int getIntValue(java.lang.String className,
                       java.lang.String fieldName)

getLongValue

public long getLongValue(java.lang.String className,
                         java.lang.String fieldName)

getStringValue

public java.lang.String getStringValue(java.lang.String className,
                                       java.lang.String fieldName)

getIntValue

public int getIntValue(java.lang.String fieldName)

getLongValue

public long getLongValue(java.lang.String fieldName)

getStringValue

public java.lang.String getStringValue(java.lang.String fieldName)

setStringValue

public void setStringValue(java.lang.String className,
                           java.lang.String fieldName,
                           java.lang.String value)

getListValue

public java.util.List getListValue(java.lang.String className,
                                   java.lang.String fieldName)

getListValue

public java.util.List getListValue(java.lang.String fieldName)

setStringListValue

public void setStringListValue(java.lang.String className,
                               java.lang.String fieldName,
                               java.util.List value)

setDBStringListValue

public void setDBStringListValue(java.lang.String className,
                                 java.lang.String fieldName,
                                 java.util.List value)

setLargeStringValue

public void setLargeStringValue(java.lang.String className,
                                java.lang.String fieldName,
                                java.lang.String value)

setIntValue

public void setIntValue(java.lang.String className,
                        java.lang.String fieldName,
                        int value)

getDatabase

public java.lang.String getDatabase()

setDatabase

public void setDatabase(java.lang.String database)

setFullName

public void setFullName(java.lang.String fullname,
                        XWikiContext context)

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

getDefaultLanguage

public java.lang.String getDefaultLanguage()

setDefaultLanguage

public void setDefaultLanguage(java.lang.String defaultLanguage)

getTranslation

public int getTranslation()

setTranslation

public void setTranslation(int translation)

getTranslatedContent

public java.lang.String getTranslatedContent(XWikiContext context)
                                      throws XWikiException

Throws:

XWikiException

getTranslatedContent

public java.lang.String getTranslatedContent(java.lang.String language,
                                             XWikiContext context)
                                      throws XWikiException

Throws:

XWikiException

getTranslatedDocument

public XWikiDocument getTranslatedDocument(XWikiContext context)
                                    throws XWikiException

Throws:

XWikiException

getTranslatedDocument

public XWikiDocument getTranslatedDocument(java.lang.String language,
                                           XWikiContext context)
                                    throws XWikiException

Throws:

XWikiException

getRealLanguage

public java.lang.String getRealLanguage(XWikiContext context)
                                 throws XWikiException

Throws:

XWikiException

getRealLanguage

public java.lang.String getRealLanguage()

Specified by:

getRealLanguage in interface DocumentModelBridge

getTranslationList

public java.util.List<java.lang.String> getTranslationList(XWikiContext context)
                                                    throws XWikiException

Throws:

XWikiException

getXMLDiff

public java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getXMLDiff(XWikiDocument fromDoc,
                                                                       XWikiDocument toDoc,
                                                                       XWikiContext context)
                                                                throws XWikiException,
                                                                       org.suigeneris.jrcs.diff.DifferentiationFailedException

Throws:

XWikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

getContentDiff

public java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getContentDiff(XWikiDocument fromDoc,
                                                                           XWikiDocument toDoc,
                                                                           XWikiContext context)
                                                                    throws XWikiException,
                                                                           org.suigeneris.jrcs.diff.DifferentiationFailedException

Throws:

XWikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

getContentDiff

public java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getContentDiff(java.lang.String fromRev,
                                                                           java.lang.String toRev,
                                                                           XWikiContext context)
                                                                    throws XWikiException,
                                                                           org.suigeneris.jrcs.diff.DifferentiationFailedException

Throws:

XWikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

getContentDiff

public java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getContentDiff(java.lang.String fromRev,
                                                                           XWikiContext context)
                                                                    throws XWikiException,
                                                                           org.suigeneris.jrcs.diff.DifferentiationFailedException

Throws:

XWikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

getLastChanges

public java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getLastChanges(XWikiContext context)
                                                                    throws XWikiException,
                                                                           org.suigeneris.jrcs.diff.DifferentiationFailedException

Throws:

XWikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

getRenderedContentDiff

public java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getRenderedContentDiff(XWikiDocument fromDoc,
                                                                                   XWikiDocument toDoc,
                                                                                   XWikiContext context)
                                                                            throws XWikiException,
                                                                                   org.suigeneris.jrcs.diff.DifferentiationFailedException

Throws:

XWikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

getRenderedContentDiff

public java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getRenderedContentDiff(java.lang.String fromRev,
                                                                                   java.lang.String toRev,
                                                                                   XWikiContext context)
                                                                            throws XWikiException,
                                                                                   org.suigeneris.jrcs.diff.DifferentiationFailedException

Throws:

XWikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

getRenderedContentDiff

public java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getRenderedContentDiff(java.lang.String fromRev,
                                                                                   XWikiContext context)
                                                                            throws XWikiException,
                                                                                   org.suigeneris.jrcs.diff.DifferentiationFailedException

Throws:

XWikiException

org.suigeneris.jrcs.diff.DifferentiationFailedException

getDeltas

protected java.util.List<org.suigeneris.jrcs.diff.delta.Delta> getDeltas(org.suigeneris.jrcs.diff.Revision rev)

getMetaDataDiff

public java.util.List<MetaDataDiff> getMetaDataDiff(java.lang.String fromRev,
                                                    java.lang.String toRev,
                                                    XWikiContext context)
                                             throws XWikiException

Throws:

XWikiException

getMetaDataDiff

public java.util.List<MetaDataDiff> getMetaDataDiff(java.lang.String fromRev,
                                                    XWikiContext context)
                                             throws XWikiException

Throws:

XWikiException

getMetaDataDiff

public java.util.List<MetaDataDiff> getMetaDataDiff(XWikiDocument fromDoc,
                                                    XWikiDocument toDoc,
                                                    XWikiContext context)
                                             throws XWikiException

Throws:

XWikiException

getObjectDiff

public java.util.List<java.util.List<ObjectDiff>> getObjectDiff(java.lang.String fromRev,
                                                                java.lang.String toRev,
                                                                XWikiContext context)
                                                         throws XWikiException

Throws:

XWikiException

getObjectDiff

public java.util.List<java.util.List<ObjectDiff>> getObjectDiff(java.lang.String fromRev,
                                                                XWikiContext context)
                                                         throws XWikiException

Throws:

XWikiException

getObjectDiff

public java.util.List<java.util.List<ObjectDiff>> getObjectDiff(XWikiDocument fromDoc,
                                                                XWikiDocument toDoc,
                                                                XWikiContext context)
                                                         throws XWikiException

Return the object differences between two document versions. There is no hard requirement on the order of the two versions, but the results are semantically correct only if the two versions are given in the right order.

Parameters:

fromDoc - The old ('before') version of the document.

toDoc - The new ('after') version of the document.

context - The context.

Returns:

The object differences. The returned list's elements are other lists, one for each changed object. The inner lists contain ObjectDiff elements, one object for each changed property of the object. Additionally, if the object was added or removed, then the first entry in the list will be an "object-added" or "object-removed" marker.

Throws:

XWikiException - If there's an error computing the differences.

getClassDiff

public java.util.List<java.util.List<ObjectDiff>> getClassDiff(XWikiDocument fromDoc,
                                                               XWikiDocument toDoc,
                                                               XWikiContext context)
                                                        throws XWikiException

Throws:

XWikiException

getAttachmentDiff

public java.util.List<AttachmentDiff> getAttachmentDiff(XWikiDocument fromDoc,
                                                        XWikiDocument toDoc,
                                                        XWikiContext context)
                                                 throws XWikiException

Parameters:

fromDoc -

toDoc -

context -

Returns:

Throws:

XWikiException

rename

public void rename(java.lang.String newDocumentName,
                   XWikiContext context)
            throws XWikiException

Rename the current document and all the backlinks leading to it. See rename(String, java.util.List, com.xpn.xwiki.XWikiContext) for more details.

Parameters:

newDocumentName - the new document name. If the space is not specified then defaults to the current space.

context - the ubiquitous XWiki Context

Throws:

XWikiException - in case of an error

rename

public void rename(java.lang.String newDocumentName,
                   java.util.List<java.lang.String> backlinkDocumentNames,
                   XWikiContext context)
            throws XWikiException

Rename the current document and all the links pointing to it in the list of passed backlink documents. The renaming algorithm takes into account the fact that there are several ways to write a link to a given page and all those forms need to be renamed. For example the following links all point to the same page:

• [Page]
• [Page?param=1]
• [currentwiki:Page]
• [CurrentSpace.Page]

Note: links without a space are renamed with the space added.

Parameters:

newDocumentName - the new document name. If the space is not specified then defaults to the current space.

backlinkDocumentNames - the list of documents to parse and for which links will be modified to point to the new renamed document.

context - the ubiquitous XWiki Context

Throws:

XWikiException - in case of an error

copyDocument

public XWikiDocument copyDocument(java.lang.String newDocumentName,
                                  XWikiContext context)
                           throws XWikiException

Throws:

XWikiException

getLock

public XWikiLock getLock(XWikiContext context)
                  throws XWikiException

Throws:

XWikiException

setLock

public void setLock(java.lang.String userName,
                    XWikiContext context)
             throws XWikiException

Throws:

XWikiException

removeLock

public void removeLock(XWikiContext context)
                throws XWikiException

Throws:

XWikiException

insertText

public void insertText(java.lang.String text,
                       java.lang.String marker,
                       XWikiContext context)
                throws XWikiException

Throws:

XWikiException

getWikiNode

public java.lang.Object getWikiNode()

setWikiNode

public void setWikiNode(java.lang.Object wikiNode)

getxWikiClassXML

public java.lang.String getxWikiClassXML()

setxWikiClassXML

public void setxWikiClassXML(java.lang.String xWikiClassXML)

getElements

public int getElements()

setElements

public void setElements(int elements)

setElement

public void setElement(int element,
                       boolean toggle)

hasElement

public boolean hasElement(int element)

getDefaultEditURL

public java.lang.String getDefaultEditURL(XWikiContext context)
                                   throws XWikiException

Throws:

XWikiException

getEditURL

public java.lang.String getEditURL(java.lang.String action,
                                   java.lang.String mode,
                                   XWikiContext context)
                            throws XWikiException

Throws:

XWikiException

getEditURL

public java.lang.String getEditURL(java.lang.String action,
                                   java.lang.String mode,
                                   java.lang.String language,
                                   XWikiContext context)

getDefaultTemplate

public java.lang.String getDefaultTemplate()

setDefaultTemplate

public void setDefaultTemplate(java.lang.String defaultTemplate)

getComments

public java.util.Vector<BaseObject> getComments()

getSyntaxId

public java.lang.String getSyntaxId()

Specified by:

getSyntaxId in interface DocumentModelBridge

See Also:

DocumentModelBridge.getSyntaxId()

setSyntaxId

public void setSyntaxId(java.lang.String syntaxId)

Parameters:

syntaxId - the new syntax id to set (eg "xwiki/1.0", "xwiki/2.0", etc)

See Also:

getSyntaxId()

getComments

public java.util.Vector<BaseObject> getComments(boolean asc)

isCurrentUserCreator

public boolean isCurrentUserCreator(XWikiContext context)

isCreator

public boolean isCreator(java.lang.String username)

isCurrentUserPage

public boolean isCurrentUserPage(XWikiContext context)

isCurrentLocalUserPage

public boolean isCurrentLocalUserPage(XWikiContext context)

resetArchive

public void resetArchive(XWikiContext context)
                  throws XWikiException

Throws:

XWikiException

addObjectFromRequest

public BaseObject addObjectFromRequest(XWikiContext context)
                                throws XWikiException

Throws:

XWikiException

addObjectFromRequest

public BaseObject addObjectFromRequest(java.lang.String className,
                                       XWikiContext context)
                                throws XWikiException

Throws:

XWikiException

addObjectFromRequest

public BaseObject addObjectFromRequest(java.lang.String className,
                                       java.lang.String prefix,
                                       XWikiContext context)
                                throws XWikiException

Throws:

XWikiException

addObjectsFromRequest

public java.util.List<BaseObject> addObjectsFromRequest(java.lang.String className,
                                                        XWikiContext context)
                                                 throws XWikiException

Throws:

XWikiException

addObjectsFromRequest

public java.util.List<BaseObject> addObjectsFromRequest(java.lang.String className,
                                                        java.lang.String pref,
                                                        XWikiContext context)
                                                 throws XWikiException

Throws:

XWikiException

addObjectFromRequest

public BaseObject addObjectFromRequest(java.lang.String className,
                                       int num,
                                       XWikiContext context)
                                throws XWikiException

Throws:

XWikiException

addObjectFromRequest

public BaseObject addObjectFromRequest(java.lang.String className,
                                       java.lang.String prefix,
                                       int num,
                                       XWikiContext context)
                                throws XWikiException

Throws:

XWikiException

updateObjectFromRequest

public BaseObject updateObjectFromRequest(java.lang.String className,
                                          XWikiContext context)
                                   throws XWikiException

Throws:

XWikiException

updateObjectFromRequest

public BaseObject updateObjectFromRequest(java.lang.String className,
                                          java.lang.String prefix,
                                          XWikiContext context)
                                   throws XWikiException

Throws:

XWikiException

updateObjectFromRequest

public BaseObject updateObjectFromRequest(java.lang.String className,
                                          java.lang.String prefix,
                                          int num,
                                          XWikiContext context)
                                   throws XWikiException

Throws:

XWikiException

updateObjectsFromRequest

public java.util.List updateObjectsFromRequest(java.lang.String className,
                                               XWikiContext context)
                                        throws XWikiException

Throws:

XWikiException

updateObjectsFromRequest

public java.util.List<BaseObject> updateObjectsFromRequest(java.lang.String className,
                                                           java.lang.String pref,
                                                           XWikiContext context)
                                                    throws XWikiException

Throws:

XWikiException

isAdvancedContent

public boolean isAdvancedContent()

isProgrammaticContent

public boolean isProgrammaticContent()

removeObject

public boolean removeObject(BaseObject bobj)

removeObjects

public boolean removeObjects(java.lang.String className)

Remove all the objects of a given type (XClass) from the document.

Parameters:

className - The class name of the objects to be removed.

getSections

public java.util.List<DocumentSection> getSections()

Returns:

the sections in the current document

getSplitSectionsAccordingToTitle

@Deprecated
public java.util.List<DocumentSection> getSplitSectionsAccordingToTitle()

Deprecated. use getSections() instead, since 1.6M1

This method to split section according to title.

Returns:

the sections in the current document

Throws:

XWikiException

getDocumentSection

public DocumentSection getDocumentSection(int sectionNumber)
                                   throws XWikiException

Throws:

XWikiException

getContentOfSection

public java.lang.String getContentOfSection(int sectionNumber)
                                     throws XWikiException

Throws:

XWikiException

updateDocumentSection

public java.lang.String updateDocumentSection(int sectionNumber,
                                              java.lang.String newSectionContent)
                                       throws XWikiException

Throws:

XWikiException

getVersionHashCode

public java.lang.String getVersionHashCode(XWikiContext context)

Computes a document hash, taking into account all document data: content, objects, attachments, metadata... TODO: cache the hash value, update only on modification.

getInternalPropertyName

public static java.lang.String getInternalPropertyName(java.lang.String propname,
                                                       XWikiContext context)

getInternalProperty

public java.lang.String getInternalProperty(java.lang.String propname)

getCustomClass

public java.lang.String getCustomClass()

setCustomClass

public void setCustomClass(java.lang.String customClass)

setValidationScript

public void setValidationScript(java.lang.String validationScript)

getValidationScript

public java.lang.String getValidationScript()

getComment

public java.lang.String getComment()

setComment

public void setComment(java.lang.String comment)

isMinorEdit

public boolean isMinorEdit()

setMinorEdit

public void setMinorEdit(boolean isMinor)

getMinorEdit1

protected java.lang.Boolean getMinorEdit1()

setMinorEdit1

protected void setMinorEdit1(java.lang.Boolean isMinor)

newObject

public BaseObject newObject(java.lang.String classname,
                            XWikiContext context)
                     throws XWikiException

Throws:

XWikiException

getObject

public BaseObject getObject(java.lang.String classname,
                            boolean create,
                            XWikiContext context)

validate

public boolean validate(XWikiContext context)
                 throws XWikiException

Throws:

XWikiException

validate

public boolean validate(java.lang.String[] classNames,
                        XWikiContext context)
                 throws XWikiException

Throws:

XWikiException

backupContext

public static void backupContext(java.util.HashMap<java.lang.String,java.lang.Object> backup,
                                 XWikiContext context)

restoreContext

public static void restoreContext(java.util.HashMap<java.lang.String,java.lang.Object> backup,
                                  XWikiContext context)

setAsContextDoc

public void setAsContextDoc(XWikiContext context)

getPreviousVersion

public java.lang.String getPreviousVersion()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setHidden

public void setHidden(java.lang.Boolean hidden)

Indicates whether the document should be 'hidden' or not, meaning that it should not be returned in public search results. WARNING: this is a temporary hack until the new data model is designed and implemented. No code should rely on or use this property, since it will be replaced with a generic metadata.

Parameters:

hidden - The new value of the hidden property.

isHidden

public java.lang.Boolean isHidden()

Indicates whether the document is 'hidden' or not, meaning that it should not be returned in public search results. WARNING: this is a temporary hack until the new data model is designed and implemented. No code should rely on or use this property, since it will be replaced with a generic metadata.

Returns:

true if the document is hidden and does not appear among the results of XWiki.searchDocuments(String), false otherwise.