com.xpn.xwiki.objects.classes
Class BaseClass

java.lang.Object
  extended by com.xpn.xwiki.objects.BaseElement
      extended by com.xpn.xwiki.objects.BaseCollection
          extended by com.xpn.xwiki.objects.classes.BaseClass
All Implemented Interfaces:
ClassInterface, ElementInterface, ObjectInterface, java.io.Serializable
Direct Known Subclasses:
MetaClass, PropertyMetaClass

public class BaseClass
extends BaseCollection
implements ClassInterface

See Also:
Serialized Form

Field Summary
private  java.lang.String customClass
           
private  java.lang.String customMapping
           
private  java.lang.String defaultEditSheet
           
private  java.lang.String defaultViewSheet
           
private  java.lang.String defaultWeb
           
private static org.apache.commons.logging.Log log
           
private  java.lang.String nameField
           
 
Fields inherited from class com.xpn.xwiki.objects.BaseCollection
className, fields, fieldsToRemove, number
 
Constructor Summary
BaseClass()
           
 
Method Summary
 boolean addBooleanField(java.lang.String fieldName, java.lang.String fieldPrettyName, java.lang.String displayType)
           
 boolean addDateField(java.lang.String fieldName, java.lang.String fieldPrettyName)
           
 boolean addDateField(java.lang.String fieldName, java.lang.String fieldPrettyName, java.lang.String dformat)
           
 boolean addDateField(java.lang.String fieldName, java.lang.String fieldPrettyName, java.lang.String dformat, int emptyIsToday)
           
 void addField(java.lang.String name, PropertyInterface element)
           
 boolean addGroupsField(java.lang.String fieldName, java.lang.String fieldPrettyName)
           
 boolean addGroupsField(java.lang.String fieldName, java.lang.String fieldPrettyName, int size)
           
 boolean addLevelsField(java.lang.String fieldName, java.lang.String fieldPrettyName)
           
 boolean addLevelsField(java.lang.String fieldName, java.lang.String fieldPrettyName, int size)
           
 boolean addNumberField(java.lang.String fieldName, java.lang.String fieldPrettyName, int size, java.lang.String type)
           
 boolean addPasswordField(java.lang.String fieldName, java.lang.String fieldPrettyName, int size)
           
 boolean addStaticListField(java.lang.String fieldName, java.lang.String fieldPrettyName, int size, boolean multiSelect, java.lang.String values)
           
 boolean addStaticListField(java.lang.String fieldName, java.lang.String fieldPrettyName, java.lang.String values)
           
 boolean addTemplateField(java.lang.String fieldName, java.lang.String fieldPrettyName)
           
 boolean addTextAreaField(java.lang.String fieldName, java.lang.String fieldPrettyName, int cols, int rows)
           
 boolean addTextField(java.lang.String fieldName, java.lang.String fieldPrettyName, int size)
           
 boolean addUsersField(java.lang.String fieldName, java.lang.String fieldPrettyName)
           
 boolean addUsersField(java.lang.String fieldName, java.lang.String fieldPrettyName, int size)
           
 java.lang.Object clone()
           
 boolean equals(java.lang.Object obj)
           
 BaseCollection fromMap(java.util.Map map, BaseCollection object)
           
 BaseCollection fromMap(java.util.Map map, XWikiContext context)
           
 BaseProperty fromString(java.lang.String value)
           
 BaseCollection fromValueMap(java.util.Map map, BaseCollection object)
           
 void fromXML(org.dom4j.Element cel)
           
 void fromXML(java.lang.String xml)
           
 PropertyInterface get(java.lang.String name)
           
 java.lang.String getCustomClass()
           
 java.lang.String getCustomMapping()
           
 java.util.List getCustomMappingPropertyList(XWikiContext context)
           
 java.lang.String getDefaultEditSheet()
           
 java.lang.String getDefaultViewSheet()
           
 java.lang.String getDefaultWeb()
           
 java.lang.String getNameField()
           
 boolean hasCustomMapping()
           
 boolean hasExternalCustomMapping()
           
 boolean hasInternalCustomMapping()
           
 boolean isCustomMappingValid(java.lang.String custommapping1, XWikiContext context)
           
 boolean isCustomMappingValid(XWikiContext context)
           
 void merge(BaseClass bclass)
           
static BaseObject newCustomClassInstance(java.lang.String className, XWikiContext context)
           
 BaseObject newCustomClassInstance(XWikiContext context)
           
 BaseCollection newObject(XWikiContext context)
           
 void put(java.lang.String name, PropertyInterface property)
           
 void setCustomClass(java.lang.String customClass)
           
 void setCustomMapping(java.lang.String customMapping)
           
 void setDefaultEditSheet(java.lang.String defaultEditSheet)
           
 void setDefaultViewSheet(java.lang.String defaultViewSheet)
           
 void setDefaultWeb(java.lang.String defaultWeb)
           
 void setNameField(java.lang.String nameField)
           
 org.dom4j.Element toXML()
           
 org.dom4j.Element toXML(BaseClass bclass)
           
 
Methods inherited from class com.xpn.xwiki.objects.BaseCollection
addPropertyForRemoval, checkField, getClassName, getDateValue, getDiff, getDoubleValue, getField, getFieldList, getFieldsToRemove, getFloatValue, getId, getIntValue, getIntValue, getLargeStringValue, getLongValue, getMap, getNumber, getProperties, getPropertyList, getPropertyNames, getSetValue, getStringValue, getxWikiClass, hashCode, merge, removeField, safeget, safeput, setClassName, setDateValue, setDoubleValue, setFields, setFieldsToRemove, setFloatValue, setId, setIntValue, setLargeStringValue, setLongValue, setNumber, setSetValue, setStringValue, toString, toXMLString
 
Methods inherited from class com.xpn.xwiki.objects.BaseElement
getName, getPrettyName, setName, setPrettyName
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.xpn.xwiki.objects.ObjectInterface
getxWikiClass, safeget, safeput
 
Methods inherited from interface com.xpn.xwiki.objects.ElementInterface
getName, setName, toString
 

Field Detail

log

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

customMapping

private java.lang.String customMapping

customClass

private java.lang.String customClass

defaultWeb

private java.lang.String defaultWeb

defaultViewSheet

private java.lang.String defaultViewSheet

defaultEditSheet

private java.lang.String defaultEditSheet

nameField

private java.lang.String nameField
Constructor Detail

BaseClass

public BaseClass()
Method Detail

addField

public void addField(java.lang.String name,
                     PropertyInterface element)
Overrides:
addField in class BaseCollection

get

public PropertyInterface get(java.lang.String name)
Specified by:
get in interface ObjectInterface
Overrides:
get in class BaseCollection

put

public void put(java.lang.String name,
                PropertyInterface property)
Specified by:
put in interface ObjectInterface
Overrides:
put in class BaseCollection

fromString

public BaseProperty fromString(java.lang.String value)

newObject

public BaseCollection newObject(XWikiContext context)
                         throws XWikiException
Throws:
XWikiException

fromMap

public BaseCollection fromMap(java.util.Map map,
                              XWikiContext context)
                       throws XWikiException
Throws:
XWikiException

fromMap

public BaseCollection fromMap(java.util.Map map,
                              BaseCollection object)

fromValueMap

public BaseCollection fromValueMap(java.util.Map map,
                                   BaseCollection object)

clone

public java.lang.Object clone()
Overrides:
clone in class BaseCollection

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class BaseCollection

merge

public void merge(BaseClass bclass)

toXML

public org.dom4j.Element toXML(BaseClass bclass)
Specified by:
toXML in interface ObjectInterface
Specified by:
toXML in class BaseCollection

toXML

public org.dom4j.Element toXML()

fromXML

public void fromXML(org.dom4j.Element cel)
             throws XWikiException
Throws:
XWikiException

fromXML

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

addTextField

public boolean addTextField(java.lang.String fieldName,
                            java.lang.String fieldPrettyName,
                            int size)

addPasswordField

public boolean addPasswordField(java.lang.String fieldName,
                                java.lang.String fieldPrettyName,
                                int size)

addBooleanField

public boolean addBooleanField(java.lang.String fieldName,
                               java.lang.String fieldPrettyName,
                               java.lang.String displayType)

addUsersField

public boolean addUsersField(java.lang.String fieldName,
                             java.lang.String fieldPrettyName)

addUsersField

public boolean addUsersField(java.lang.String fieldName,
                             java.lang.String fieldPrettyName,
                             int size)

addLevelsField

public boolean addLevelsField(java.lang.String fieldName,
                              java.lang.String fieldPrettyName)

addLevelsField

public boolean addLevelsField(java.lang.String fieldName,
                              java.lang.String fieldPrettyName,
                              int size)

addGroupsField

public boolean addGroupsField(java.lang.String fieldName,
                              java.lang.String fieldPrettyName)

addGroupsField

public boolean addGroupsField(java.lang.String fieldName,
                              java.lang.String fieldPrettyName,
                              int size)

addTemplateField

public boolean addTemplateField(java.lang.String fieldName,
                                java.lang.String fieldPrettyName)

addTextAreaField

public boolean addTextAreaField(java.lang.String fieldName,
                                java.lang.String fieldPrettyName,
                                int cols,
                                int rows)

addStaticListField

public boolean addStaticListField(java.lang.String fieldName,
                                  java.lang.String fieldPrettyName,
                                  java.lang.String values)

addStaticListField

public boolean addStaticListField(java.lang.String fieldName,
                                  java.lang.String fieldPrettyName,
                                  int size,
                                  boolean multiSelect,
                                  java.lang.String values)

addNumberField

public boolean addNumberField(java.lang.String fieldName,
                              java.lang.String fieldPrettyName,
                              int size,
                              java.lang.String type)

addDateField

public boolean addDateField(java.lang.String fieldName,
                            java.lang.String fieldPrettyName)

addDateField

public boolean addDateField(java.lang.String fieldName,
                            java.lang.String fieldPrettyName,
                            java.lang.String dformat)

addDateField

public boolean addDateField(java.lang.String fieldName,
                            java.lang.String fieldPrettyName,
                            java.lang.String dformat,
                            int emptyIsToday)

setCustomMapping

public void setCustomMapping(java.lang.String customMapping)

getCustomMapping

public java.lang.String getCustomMapping()

hasCustomMapping

public boolean hasCustomMapping()

hasExternalCustomMapping

public boolean hasExternalCustomMapping()

hasInternalCustomMapping

public boolean hasInternalCustomMapping()

isCustomMappingValid

public boolean isCustomMappingValid(XWikiContext context)
                             throws XWikiException
Throws:
XWikiException

isCustomMappingValid

public boolean isCustomMappingValid(java.lang.String custommapping1,
                                    XWikiContext context)
                             throws XWikiException
Throws:
XWikiException

getCustomMappingPropertyList

public java.util.List getCustomMappingPropertyList(XWikiContext context)

setCustomClass

public void setCustomClass(java.lang.String customClass)

getCustomClass

public java.lang.String getCustomClass()

newCustomClassInstance

public BaseObject newCustomClassInstance(XWikiContext context)
                                  throws XWikiException
Throws:
XWikiException

newCustomClassInstance

public static BaseObject newCustomClassInstance(java.lang.String className,
                                                XWikiContext context)
                                         throws XWikiException
Throws:
XWikiException

getDefaultWeb

public java.lang.String getDefaultWeb()

setDefaultWeb

public void setDefaultWeb(java.lang.String defaultWeb)

getDefaultViewSheet

public java.lang.String getDefaultViewSheet()

setDefaultViewSheet

public void setDefaultViewSheet(java.lang.String defaultViewSheet)

getDefaultEditSheet

public java.lang.String getDefaultEditSheet()

setDefaultEditSheet

public void setDefaultEditSheet(java.lang.String defaultEditSheet)

getNameField

public java.lang.String getNameField()

setNameField

public void setNameField(java.lang.String nameField)


Copyright 2003 Ludovic Dubost