com.xpn.xwiki.doc
Class XWikiDocument

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

public class XWikiDocument
extends java.lang.Object


Field Summary
private  org.apache.commons.jrcs.rcs.Archive archive
           
private  java.util.List attachmentList
           
private  java.lang.String author
           
private  java.lang.String content
           
private  java.lang.String contentAuthor
           
private  java.util.Date contentUpdateDate
           
private  java.util.Date creationDate
           
private  java.lang.String creator
           
private  java.lang.String database
           
private  java.lang.String defaultLanguage
           
private  java.lang.String defaultTemplate
           
private  int elements
           
private  java.lang.String format
           
private  boolean fromCache
           
static int HAS_ATTACHMENTS
           
private static int HAS_CLASS
           
static int HAS_OBJECTS
           
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  XWikiStoreInterface store
           
private  java.lang.String template
           
private  java.lang.String title
           
private  int translation
           
private  java.util.Date updateDate
           
private  org.apache.commons.jrcs.rcs.Version version
           
private  java.lang.String web
           
private  java.lang.Object wikiNode
           
private  BaseClass xWikiClass
           
private  java.lang.String xWikiClassXML
           
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, BaseObject object)
           
 BaseObject addObjectFromRequest(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)
           
 java.lang.Object clone()
           
 void clonexWikiObjects(XWikiDocument templatedoc)
           
 void copyAttachments(XWikiDocument xWikiSourceDocument)
           
 int createNewObject(java.lang.String classname, 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 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 displayRendered(PropertyClass pclass, java.lang.String prefix, BaseCollection object, XWikiContext context)
           
 java.lang.String displaySearch(PropertyClass pclass, java.lang.String prefix, BaseCollection object, 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(java.lang.String xml)
           
 void fromXML(java.lang.String xml, boolean withArchive)
           
 java.lang.String getArchive()
           
 java.lang.String getArchive(XWikiContext context)
           
 XWikiAttachment getAttachment(java.lang.String filename)
           
 java.util.List 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)
           
 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 getClassDiff(XWikiDocument origdoc, XWikiDocument newdoc, XWikiContext context)
           
 java.util.Vector getComments()
           
 java.util.Vector getComments(boolean asc)
           
 java.lang.String getContent()
           
 java.lang.String getContentAuthor()
           
 java.util.List getContentDiff(java.lang.String origrev, java.lang.String newrev, XWikiContext context)
           
 java.util.List getContentDiff(java.lang.String rev, XWikiContext context)
           
 java.util.List getContentDiff(XWikiDocument origdoc, XWikiDocument newdoc, XWikiContext context)
           
 java.util.Date getContentUpdateDate()
           
 java.util.Date getCreationDate()
           
 java.lang.String getCreator()
           
 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 getDeltas(org.apache.commons.jrcs.diff.Revision rev)
           
 java.lang.String getDisplayTitle()
           
 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 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 getIncludedMacros(XWikiContext context)
           
 java.util.List getIncludedPages(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(XWikiContext context)
           
 java.util.List getLinkedPages(XWikiContext context)
           
 java.util.List getLinks(XWikiContext context)
           
 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 getMetaDataDiff(java.lang.String origrev, java.lang.String newrev, XWikiContext context)
           
 java.util.List getMetaDataDiff(java.lang.String rev, XWikiContext context)
           
 java.util.List getMetaDataDiff(XWikiDocument origdoc, XWikiDocument newdoc, XWikiContext context)
           
 java.lang.String getName()
           
 BaseObject getObject(java.lang.String classname)
           
 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 getObjectDiff(java.lang.String origrev, java.lang.String newrev, XWikiContext context)
           
 java.util.List getObjectDiff(java.lang.String rev, XWikiContext context)
           
 java.util.List getObjectDiff(XWikiDocument origdoc, XWikiDocument newdoc, 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(XWikiContext context)
           
 org.apache.commons.jrcs.rcs.Archive getRCSArchive()
           
 org.apache.commons.jrcs.rcs.Version getRCSVersion()
           
 java.lang.String getRealLanguage(XWikiContext context)
           
 java.lang.String[] getRecentRevisions(int nb, XWikiContext context)
           
 java.lang.String getRenderedContent(java.lang.String text, XWikiContext context)
           
 java.lang.String getRenderedContent(XWikiContext context)
           
 java.util.List getRenderedContentDiff(java.lang.String origrev, java.lang.String newrev, XWikiContext context)
           
 java.util.List getRenderedContentDiff(java.lang.String rev, XWikiContext context)
           
 java.util.List getRenderedContentDiff(XWikiDocument origdoc, XWikiDocument newdoc, XWikiContext context)
           
 org.apache.commons.jrcs.rcs.Version[] getRevisions(XWikiContext context)
           
 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 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 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 querystring, XWikiContext context)
           
 java.lang.String getURL(java.lang.String action, XWikiContext context)
           
 java.lang.String getVersion()
           
 java.lang.String getWeb()
           
 java.lang.Object getWikiNode()
           
 java.lang.String getXMLContent(XWikiContext context)
           
 java.util.List getXMLDiff(XWikiDocument origdoc, XWikiDocument newdoc, XWikiContext context)
           
 BaseClass getxWikiClass()
           
 java.util.List getxWikiClasses(XWikiContext context)
           
 java.lang.String getxWikiClassXML()
           
 BaseObject getxWikiObject()
           
 java.util.Map getxWikiObjects()
           
 boolean hasElement(int element)
           
 void incrementVersion()
           
 void insertText(java.lang.String text, java.lang.String marker, XWikiContext context)
           
 boolean isContentDirty()
           
 boolean isCreator(java.lang.String username)
           
 boolean isCurrentLocalUserPage(XWikiContext context)
           
 boolean isCurrentUserCreator(XWikiContext context)
           
 boolean isCurrentUserPage(XWikiContext context)
           
 boolean isFromCache()
           
 boolean isMetaDataDirty()
           
 boolean isMostRecent()
           
 boolean isNew()
           
 void loadAttachmentContent(XWikiAttachment attachment, XWikiContext context)
           
 void loadAttachments(XWikiContext context)
           
 void mergexWikiClass(XWikiDocument templatedoc)
           
 void mergexWikiObjects(XWikiDocument templatedoc)
           
 void notify(XWikiNotificationRule rule, XWikiDocument newdoc, XWikiDocument olddoc, int event, XWikiContext context)
           
 void readFromForm(EditForm eform, XWikiContext context)
           
 void readFromTemplate(EditForm eform, XWikiContext context)
           
 void readFromTemplate(java.lang.String template, XWikiContext context)
           
 void removeLock(XWikiContext context)
           
 XWikiDocument renameDocument(java.lang.String docname, XWikiContext context)
           
 void renameProperties(java.lang.String className, java.util.Map fieldsToRename)
           
 void saveAllAttachments(XWikiContext context)
           
 void saveAttachmentContent(XWikiAttachment attachment, 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 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 setDatabase(java.lang.String database)
           
 void setDate(java.util.Date date)
           
 void setDefaultLanguage(java.lang.String defaultLanguage)
           
 void setDefaultTemplate(java.lang.String defaultTemplate)
           
 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 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 setMostRecent(boolean mostRecent)
           
 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 objects)
           
 void setObjectsToRemove(java.util.ArrayList objectsToRemove)
           
 void setParent(java.lang.String parent)
           
 void setRCSArchive(org.apache.commons.jrcs.rcs.Archive archive)
           
 void setRCSVersion(org.apache.commons.jrcs.rcs.Version version)
           
 void setStore(XWikiStoreInterface store)
           
 void setStringValue(java.lang.String className, java.lang.String fieldName, java.lang.String value)
           
 void setTemplate(java.lang.String template)
           
 void setTitle(java.lang.String title)
           
 void setTranslation(int translation)
           
 void setVersion(java.lang.String version)
           
 void setWeb(java.lang.String web)
           
 void setWikiNode(java.lang.Object wikiNode)
           
 void setxWikiClass(BaseClass xWikiClass)
           
 void setxWikiClassXML(java.lang.String xWikiClassXML)
           
 void setxWikiObjects(java.util.Map xWikiObjects)
           
 java.lang.String toFullXML(XWikiContext context)
           
 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)
           
 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

title

private java.lang.String title

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

contentAuthor

private java.lang.String contentAuthor

archive

private org.apache.commons.jrcs.rcs.Archive archive

contentUpdateDate

private java.util.Date contentUpdateDate

updateDate

private java.util.Date updateDate

creationDate

private java.util.Date creationDate

version

private org.apache.commons.jrcs.rcs.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

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

private static final int HAS_CLASS
See Also:
Constant Field Values

elements

private int elements

xWikiClass

private BaseClass xWikiClass

xWikiClassXML

private java.lang.String xWikiClassXML

xWikiObjects

private java.util.Map xWikiObjects

attachmentList

private java.util.List attachmentList

fromCache

private boolean fromCache

objectsToRemove

private java.util.ArrayList objectsToRemove

defaultTemplate

private java.lang.String defaultTemplate

wikiNode

private java.lang.Object wikiNode

store

private XWikiStoreInterface store
Constructor Detail

XWikiDocument

public XWikiDocument()

XWikiDocument

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

getStore

public XWikiStoreInterface getStore()

setStore

public void setStore(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 org.apache.commons.jrcs.rcs.Version getRCSVersion()

setRCSVersion

public void setRCSVersion(org.apache.commons.jrcs.rcs.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(XWikiContext context)
                                    throws XWikiException
Throws:
XWikiException

getRenderedContent

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

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()

setFullName

public void setFullName(java.lang.String name)

getTitle

public java.lang.String getTitle()

getDisplayTitle

public java.lang.String getDisplayTitle()

extractTitle

public java.lang.String extractTitle()

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)

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,
                               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)

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

getRevisions

public org.apache.commons.jrcs.rcs.Version[] getRevisions(XWikiContext context)
                                                   throws XWikiException
Throws:
XWikiException

getRecentRevisions

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

getRCSArchive

public org.apache.commons.jrcs.rcs.Archive getRCSArchive()

setRCSArchive

public void setRCSArchive(org.apache.commons.jrcs.rcs.Archive archive)

getArchive

public java.lang.String getArchive()
                            throws XWikiException
Throws:
XWikiException

getArchive

public java.lang.String getArchive(XWikiContext context)
                            throws XWikiException
Throws:
XWikiException

setArchive

public void setArchive(java.lang.String text)
                throws XWikiException
Throws:
XWikiException

updateArchive

public void updateArchive(java.lang.String text)
                   throws XWikiException
Throws:
XWikiException

isMostRecent

public boolean isMostRecent()

setMostRecent

public void setMostRecent(boolean mostRecent)

getxWikiClass

public BaseClass getxWikiClass()

setxWikiClass

public void setxWikiClass(BaseClass xWikiClass)

getxWikiObjects

public java.util.Map getxWikiObjects()

setxWikiObjects

public void setxWikiObjects(java.util.Map xWikiObjects)

getxWikiObject

public BaseObject getxWikiObject()

getxWikiClasses

public java.util.List 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 getObjects(java.lang.String classname)

setObjects

public void setObjects(java.lang.String classname,
                       java.util.Vector 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()

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)

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,
                                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)

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)

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.lang.String xml,
                    boolean withArchive)
             throws XWikiException
Throws:
XWikiException

setAttachmentList

public void setAttachmentList(java.util.List list)

getAttachmentList

public java.util.List getAttachmentList()

saveAllAttachments

public void saveAllAttachments(XWikiContext context)
                        throws XWikiException
Throws:
XWikiException

saveAttachmentContent

public void saveAttachmentContent(XWikiAttachment attachment,
                                  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

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 getObjectsToRemove()

setObjectsToRemove

public void setObjectsToRemove(java.util.ArrayList objectsToRemove)

getIncludedPages

public java.util.List getIncludedPages(XWikiContext context)

getIncludedMacros

public java.util.List getIncludedMacros(XWikiContext context)

getLinkedPages

public java.util.List getLinkedPages(XWikiContext context)

displayRendered

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

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,
                                      BaseCollection object,
                                      XWikiContext context)

getAttachment

public XWikiAttachment getAttachment(java.lang.String filename)

getFirstObject

public BaseObject getFirstObject(java.lang.String fieldname)

getFirstObject

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

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)

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

getTranslationList

public java.util.List getTranslationList(XWikiContext context)
                                  throws XWikiException
Throws:
XWikiException

getXMLDiff

public java.util.List getXMLDiff(XWikiDocument origdoc,
                                 XWikiDocument newdoc,
                                 XWikiContext context)
                          throws XWikiException,
                                 org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getContentDiff

public java.util.List getContentDiff(XWikiDocument origdoc,
                                     XWikiDocument newdoc,
                                     XWikiContext context)
                              throws XWikiException,
                                     org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getContentDiff

public java.util.List getContentDiff(java.lang.String origrev,
                                     java.lang.String newrev,
                                     XWikiContext context)
                              throws XWikiException,
                                     org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getContentDiff

public java.util.List getContentDiff(java.lang.String rev,
                                     XWikiContext context)
                              throws XWikiException,
                                     org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getLastChanges

public java.util.List getLastChanges(XWikiContext context)
                              throws XWikiException,
                                     org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getRenderedContentDiff

public java.util.List getRenderedContentDiff(XWikiDocument origdoc,
                                             XWikiDocument newdoc,
                                             XWikiContext context)
                                      throws XWikiException,
                                             org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getRenderedContentDiff

public java.util.List getRenderedContentDiff(java.lang.String origrev,
                                             java.lang.String newrev,
                                             XWikiContext context)
                                      throws XWikiException,
                                             org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getRenderedContentDiff

public java.util.List getRenderedContentDiff(java.lang.String rev,
                                             XWikiContext context)
                                      throws XWikiException,
                                             org.apache.commons.jrcs.diff.DifferentiationFailedException
Throws:
XWikiException
org.apache.commons.jrcs.diff.DifferentiationFailedException

getDeltas

protected java.util.List getDeltas(org.apache.commons.jrcs.diff.Revision rev)

getMetaDataDiff

public java.util.List getMetaDataDiff(java.lang.String origrev,
                                      java.lang.String newrev,
                                      XWikiContext context)
                               throws XWikiException
Throws:
XWikiException

getMetaDataDiff

public java.util.List getMetaDataDiff(java.lang.String rev,
                                      XWikiContext context)
                               throws XWikiException
Throws:
XWikiException

getMetaDataDiff

public java.util.List getMetaDataDiff(XWikiDocument origdoc,
                                      XWikiDocument newdoc,
                                      XWikiContext context)
                               throws XWikiException
Throws:
XWikiException

getObjectDiff

public java.util.List getObjectDiff(java.lang.String origrev,
                                    java.lang.String newrev,
                                    XWikiContext context)
                             throws XWikiException
Throws:
XWikiException

getObjectDiff

public java.util.List getObjectDiff(java.lang.String rev,
                                    XWikiContext context)
                             throws XWikiException
Throws:
XWikiException

getObjectDiff

public java.util.List getObjectDiff(XWikiDocument origdoc,
                                    XWikiDocument newdoc,
                                    XWikiContext context)
                             throws XWikiException
Throws:
XWikiException

getClassDiff

public java.util.List getClassDiff(XWikiDocument origdoc,
                                   XWikiDocument newdoc,
                                   XWikiContext context)
                            throws XWikiException
Throws:
XWikiException

renameDocument

public XWikiDocument renameDocument(java.lang.String docname,
                                    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

addObjectFromRequest

public BaseObject addObjectFromRequest(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 getComments()

getComments

public java.util.Vector 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)


Copyright 2003 Ludovic Dubost