Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> xpn >> xwiki >> [ doc overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.xpn.xwiki.doc
Class XWikiDocument  

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

---

public class XWikiDocument

extends java.lang.Object

---

Field Summary
private  Archive	archive
private  java.util.List	attachmentList
private  java.lang.String	author
private  java.lang.String	content
private  java.util.Date	creationDate
private  java.lang.String	creator
private  java.lang.String	database
private  java.lang.String	defaultLanguage
private  java.lang.String	format
private  boolean	fromCache
private  long	id
private  boolean	isContentDirty
private  boolean	isMetaDataDirty
private  boolean	isNew
private  java.lang.String	language
private static org.apache.commons.logging.Log	log
private  java.lang.String	meta
private  boolean	mostRecent
private  java.lang.String	name
private  java.util.ArrayList	objectsToRemove
private  java.lang.String	parent
private  com.xpn.xwiki.store.XWikiStoreInterface	store
private  java.lang.String	template
private  int	translation
private  java.util.Date	updateDate
private  Version	version
private  java.lang.String	web
private  com.xpn.xwiki.objects.classes.BaseClass	xWikiClass
private  java.util.Map	xWikiObjects

 

Constructor Summary

XWikiDocument()

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

 

Method Summary
void	addObject(java.lang.String classname, com.xpn.xwiki.objects.BaseObject object)
com.xpn.xwiki.objects.BaseObject	addObjectFromRequest(com.xpn.xwiki.XWikiContext context)
void	addObjectsToRemove(com.xpn.xwiki.objects.BaseObject object)
void	addToZip(java.util.zip.ZipOutputStream zos, boolean withVersions, com.xpn.xwiki.XWikiContext context)
void	addToZip(java.util.zip.ZipOutputStream zos, com.xpn.xwiki.XWikiContext context)
void	appendMeta(java.lang.String meta)
java.lang.Object	clone()           This method may be called to create a new copy of the Object.
void	copyAttachments(XWikiDocument xWikiSourceDocument)
int	createNewObject(java.lang.String classname, com.xpn.xwiki.XWikiContext context)
void	deleteAttachment(XWikiAttachment attachment, com.xpn.xwiki.XWikiContext context)
java.lang.String	display(java.lang.String fieldname, com.xpn.xwiki.objects.BaseObject obj, com.xpn.xwiki.XWikiContext context)
java.lang.String	display(java.lang.String fieldname, java.lang.String type, com.xpn.xwiki.objects.BaseObject obj, com.xpn.xwiki.XWikiContext context)
java.lang.String	display(java.lang.String fieldname, java.lang.String mode, com.xpn.xwiki.XWikiContext context)
java.lang.String	display(java.lang.String fieldname, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayEdit(com.xpn.xwiki.objects.classes.PropertyClass pclass, java.lang.String prefix, com.xpn.xwiki.objects.BaseCollection object, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayForm(java.lang.String className, java.lang.String header, java.lang.String format, boolean linebreak, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayForm(java.lang.String className, java.lang.String header, java.lang.String format, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayForm(java.lang.String className, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayHidden(com.xpn.xwiki.objects.classes.PropertyClass pclass, java.lang.String prefix, com.xpn.xwiki.objects.BaseCollection object, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayRendered(com.xpn.xwiki.objects.classes.PropertyClass pclass, java.lang.String prefix, com.xpn.xwiki.objects.BaseCollection object, com.xpn.xwiki.XWikiContext context)
java.lang.String	displaySearch(com.xpn.xwiki.objects.classes.PropertyClass pclass, java.lang.String prefix, com.xpn.xwiki.objects.BaseCollection object, com.xpn.xwiki.XWikiContext context)
java.lang.String	displayView(com.xpn.xwiki.objects.classes.PropertyClass pclass, java.lang.String prefix, com.xpn.xwiki.objects.BaseCollection object, com.xpn.xwiki.XWikiContext context)
protected  java.lang.String	encodedXMLStringAsUTF8(java.lang.String xmlString)
boolean	equals(java.lang.Object object)           Determine whether this Object is semantically equal to another Object.
void	fromXML(java.lang.String xml)
void	fromXML(java.lang.String xml, boolean withArchive)
java.lang.String	getArchive()
java.lang.String	getArchive(com.xpn.xwiki.XWikiContext context)
XWikiAttachment	getAttachment(java.lang.String filename)
java.util.List	getAttachmentList()
java.lang.String	getAttachmentURL(java.lang.String filename, java.lang.String action, com.xpn.xwiki.XWikiContext context)
java.lang.String	getAttachmentURL(java.lang.String filename, com.xpn.xwiki.XWikiContext context)
java.lang.String	getAuthor()
java.util.List	getClassDiff(XWikiDocument origdoc, XWikiDocument newdoc, com.xpn.xwiki.XWikiContext context)
java.lang.String	getContent()
java.util.List	getContentDiff(java.lang.String origrev, java.lang.String newrev, com.xpn.xwiki.XWikiContext context)
java.util.List	getContentDiff(java.lang.String rev, com.xpn.xwiki.XWikiContext context)
java.util.List	getContentDiff(XWikiDocument origdoc, XWikiDocument newdoc, com.xpn.xwiki.XWikiContext context)
java.util.Date	getCreationDate()
java.lang.String	getCreator()
java.lang.String	getDatabase()
java.util.Date	getDate()
java.lang.String	getDefaultLanguage()
protected  java.util.List	getDeltas(Revision rev)
protected  java.lang.String	getElement(org.dom4j.Element docel, java.lang.String name)
java.lang.String	getEscapedContent(com.xpn.xwiki.XWikiContext context)
java.lang.String	getExternalURL(java.lang.String action, java.lang.String querystring, com.xpn.xwiki.XWikiContext context)
java.lang.String	getExternalURL(java.lang.String action, com.xpn.xwiki.XWikiContext context)
com.xpn.xwiki.objects.BaseObject	getFirstObject(java.lang.String fieldname)
java.lang.String	getFormat()
java.lang.String	getFullName()
long	getId()
java.util.List	getIncludedMacros(com.xpn.xwiki.XWikiContext context)
java.util.List	getIncludedPages(com.xpn.xwiki.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	getLastChanges(com.xpn.xwiki.XWikiContext context)
java.util.List	getLinkedPages(com.xpn.xwiki.XWikiContext context)
XWikiLock	getLock(com.xpn.xwiki.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	getMetaDataDiff(java.lang.String origrev, java.lang.String newrev, com.xpn.xwiki.XWikiContext context)
java.util.List	getMetaDataDiff(java.lang.String rev, com.xpn.xwiki.XWikiContext context)
java.util.List	getMetaDataDiff(XWikiDocument origdoc, XWikiDocument newdoc, com.xpn.xwiki.XWikiContext context)
java.lang.String	getName()
com.xpn.xwiki.objects.BaseObject	getObject(java.lang.String classname)
com.xpn.xwiki.objects.BaseObject	getObject(java.lang.String classname, int nb)
com.xpn.xwiki.objects.BaseObject	getObject(java.lang.String classname, java.lang.String key, java.lang.String value)
com.xpn.xwiki.objects.BaseObject	getObject(java.lang.String classname, java.lang.String key, java.lang.String value, boolean failover)
java.util.List	getObjectDiff(java.lang.String origrev, java.lang.String newrev, com.xpn.xwiki.XWikiContext context)
java.util.List	getObjectDiff(java.lang.String rev, com.xpn.xwiki.XWikiContext context)
java.util.List	getObjectDiff(XWikiDocument origdoc, XWikiDocument newdoc, com.xpn.xwiki.XWikiContext context)
int	getObjectNumbers(java.lang.String classname)
java.util.Vector	getObjects(java.lang.String classname)
java.util.ArrayList	getObjectsToRemove()
java.lang.String	getParent()
XWikiDocument	getParentDoc()
java.lang.String	getParentURL(com.xpn.xwiki.XWikiContext context)
Archive	getRCSArchive()
Version	getRCSVersion()
java.lang.String	getRealLanguage(com.xpn.xwiki.XWikiContext context)
java.lang.String[]	getRecentRevisions(int nb, com.xpn.xwiki.XWikiContext context)
java.lang.String	getRenderedContent(java.lang.String text, com.xpn.xwiki.XWikiContext context)
java.lang.String	getRenderedContent(com.xpn.xwiki.XWikiContext context)
java.util.List	getRenderedContentDiff(java.lang.String origrev, java.lang.String newrev, com.xpn.xwiki.XWikiContext context)
java.util.List	getRenderedContentDiff(java.lang.String rev, com.xpn.xwiki.XWikiContext context)
java.util.List	getRenderedContentDiff(XWikiDocument origdoc, XWikiDocument newdoc, com.xpn.xwiki.XWikiContext context)
Version[]	getRevisions(com.xpn.xwiki.XWikiContext context)
com.xpn.xwiki.store.XWikiStoreInterface	getStore()
java.lang.String	getStringValue(java.lang.String fieldName)
java.lang.String	getStringValue(java.lang.String className, java.lang.String fieldName)
java.lang.String	getTemplate()
java.lang.String	getTranslatedContent(java.lang.String language, com.xpn.xwiki.XWikiContext context)
java.lang.String	getTranslatedContent(com.xpn.xwiki.XWikiContext context)
XWikiDocument	getTranslatedDocument(java.lang.String language, com.xpn.xwiki.XWikiContext context)
XWikiDocument	getTranslatedDocument(com.xpn.xwiki.XWikiContext context)
int	getTranslation()
java.util.List	getTranslationList(com.xpn.xwiki.XWikiContext context)
java.lang.String	getURL(java.lang.String action, boolean redirect, com.xpn.xwiki.XWikiContext context)
java.lang.String	getURL(java.lang.String action, java.lang.String querystring, com.xpn.xwiki.XWikiContext context)
java.lang.String	getURL(java.lang.String action, com.xpn.xwiki.XWikiContext context)
java.lang.String	getVersion()
java.lang.String	getWeb()
java.lang.String	getXMLContent(com.xpn.xwiki.XWikiContext context)
java.util.List	getXMLDiff(XWikiDocument origdoc, XWikiDocument newdoc, com.xpn.xwiki.XWikiContext context)
com.xpn.xwiki.objects.classes.BaseClass	getxWikiClass()
java.util.List	getxWikiClasses(com.xpn.xwiki.XWikiContext context)
com.xpn.xwiki.objects.BaseObject	getxWikiObject()
java.util.Map	getxWikiObjects()
void	incrementVersion()
void	insertText(java.lang.String text, java.lang.String marker, com.xpn.xwiki.XWikiContext context)
boolean	isContentDirty()
boolean	isFromCache()
boolean	isMetaDataDirty()
boolean	isMostRecent()
boolean	isNew()
void	loadAttachmentContent(XWikiAttachment attachment, com.xpn.xwiki.XWikiContext context)
void	mergexWikiClass(XWikiDocument templatedoc)
void	mergexWikiObjects(XWikiDocument templatedoc)
void	notify(com.xpn.xwiki.notify.XWikiNotificationRule rule, XWikiDocument newdoc, XWikiDocument olddoc, int event, com.xpn.xwiki.XWikiContext context)
void	readFromForm(com.xpn.xwiki.web.EditForm eform, com.xpn.xwiki.XWikiContext context)
void	readFromTemplate(com.xpn.xwiki.web.PrepareEditForm eform, com.xpn.xwiki.XWikiContext context)
void	readFromTemplate(java.lang.String template, com.xpn.xwiki.XWikiContext context)
void	removeLock(com.xpn.xwiki.XWikiContext context)
XWikiDocument	renameDocument(java.lang.String docname, com.xpn.xwiki.XWikiContext context)
void	renameProperties(java.lang.String className, java.util.Map fieldsToRename)
void	saveAttachmentContent(XWikiAttachment attachment, com.xpn.xwiki.XWikiContext context)
void	setArchive(java.lang.String text)
void	setAttachmentList(java.util.List list)
void	setAuthor(java.lang.String author)
void	setContent(java.lang.String content)
void	setContentDirty(boolean contentDirty)
void	setCreationDate(java.util.Date date)
void	setCreator(java.lang.String creator)
void	setDatabase(java.lang.String database)
void	setDate(java.util.Date date)
void	setDefaultLanguage(java.lang.String defaultLanguage)
void	setFormat(java.lang.String format)
void	setFromCache(boolean fromCache)
void	setFullName(java.lang.String name)
void	setFullName(java.lang.String fullname, com.xpn.xwiki.XWikiContext context)
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, com.xpn.xwiki.XWikiContext context)
void	setMeta(java.lang.String meta)
void	setMetaDataDirty(boolean metaDataDirty)
void	setMostRecent(boolean mostRecent)
void	setName(java.lang.String name)
void	setNew(boolean aNew)
void	setObject(java.lang.String classname, int nb, com.xpn.xwiki.objects.BaseObject object)
void	setObjects(java.lang.String classname, java.util.Vector objects)
void	setObjectsToRemove(java.util.ArrayList objectsToRemove)
void	setParent(java.lang.String parent)
void	setRCSArchive(Archive archive)
void	setRCSVersion(Version version)
void	setStore(com.xpn.xwiki.store.XWikiStoreInterface store)
void	setStringValue(java.lang.String className, java.lang.String fieldName, java.lang.String value)
void	setTemplate(java.lang.String template)
void	setTranslation(int translation)
void	setVersion(java.lang.String version)
void	setWeb(java.lang.String web)
void	setxWikiClass(com.xpn.xwiki.objects.classes.BaseClass xWikiClass)
void	setxWikiObjects(java.util.Map xWikiObjects)
java.lang.String	toFullXML(com.xpn.xwiki.XWikiContext context)
java.lang.String	toXML(boolean bWithObjects, boolean bWithRendering, boolean bWithAttachmentContent, boolean bWithVersions, com.xpn.xwiki.XWikiContext context)
java.lang.String	toXML(org.dom4j.Document doc, com.xpn.xwiki.XWikiContext context)
java.lang.String	toXML(com.xpn.xwiki.XWikiContext context)
org.dom4j.Document	toXMLDocument(boolean bWithObjects, boolean bWithRendering, boolean bWithAttachmentContent, boolean bWithVersions, com.xpn.xwiki.XWikiContext context)
org.dom4j.Document	toXMLDocument(com.xpn.xwiki.XWikiContext context)
void	updateArchive(java.lang.String text)

 

Methods inherited from class java.lang.Object

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

 

Field Detail

log

private static final org.apache.commons.logging.Log log

---

parent

private java.lang.String parent

---

web

private java.lang.String web

---

name

private java.lang.String name

---

content

private java.lang.String content

---

meta

private java.lang.String meta

---

format

private java.lang.String format

---

creator

private java.lang.String creator

---

author

private java.lang.String author

---

archive

private Archive archive

---

updateDate

private java.util.Date updateDate

---

creationDate

private java.util.Date creationDate

---

version

private Version version

---

id

private long id

---

mostRecent

private boolean mostRecent

---

isNew

private boolean isNew

---

template

private java.lang.String template

---

language

private java.lang.String language

---

defaultLanguage

private java.lang.String defaultLanguage

---

translation

private int translation

---

database

private java.lang.String database

---

isContentDirty

private boolean isContentDirty

---

isMetaDataDirty

private boolean isMetaDataDirty

---

xWikiClass

private com.xpn.xwiki.objects.classes.BaseClass xWikiClass

---

xWikiObjects

private java.util.Map xWikiObjects

---

attachmentList

private java.util.List attachmentList

---

fromCache

private boolean fromCache

---

objectsToRemove

private java.util.ArrayList objectsToRemove

---

store

private com.xpn.xwiki.store.XWikiStoreInterface store

Constructor Detail

XWikiDocument

public XWikiDocument()

---

XWikiDocument

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

Method Detail

getStore

public com.xpn.xwiki.store.XWikiStoreInterface getStore()

---

setStore

public void setStore(com.xpn.xwiki.store.XWikiStoreInterface store)

---

getId

public long getId()

---

setId

public void setId(long id)

---

getWeb

public java.lang.String getWeb()

---

setWeb

public void setWeb(java.lang.String web)

---

getVersion

public java.lang.String getVersion()

---

setVersion

public void setVersion(java.lang.String version)

---

getRCSVersion

public Version getRCSVersion()

---

setRCSVersion

public void setRCSVersion(Version version)

---

getParentDoc

public XWikiDocument getParentDoc()

---

getParent

public java.lang.String getParent()

---

setParent

public void setParent(java.lang.String parent)

---

getContent

public java.lang.String getContent()

---

setContent

public void setContent(java.lang.String content)

---

getRenderedContent

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

---

getRenderedContent

public java.lang.String getRenderedContent(java.lang.String text,
                                           com.xpn.xwiki.XWikiContext context)

---

getEscapedContent

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

---

getName

public java.lang.String getName()

---

setName

public void setName(java.lang.String name)

---

getFullName

public java.lang.String getFullName()

---

setFullName

public void setFullName(java.lang.String name)

---

getFormat

public java.lang.String getFormat()

---

setFormat

public void setFormat(java.lang.String format)

---

getAuthor

public java.lang.String getAuthor()

---

setAuthor

public void setAuthor(java.lang.String author)

---

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)

---

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,
                                         com.xpn.xwiki.XWikiContext context)

---

getAttachmentURL

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

---

getURL

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

---

getURL

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

---

getURL

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

---

getExternalURL

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

---

getExternalURL

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

---

getParentURL

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

---

getRevisions

public Version[] getRevisions(com.xpn.xwiki.XWikiContext context)
                       throws com.xpn.xwiki.XWikiException

---

getRecentRevisions

public java.lang.String[] getRecentRevisions(int nb,
                                             com.xpn.xwiki.XWikiContext context)