com.xpn.xwiki.objects
Class BaseCollection

java.lang.Object
  com.xpn.xwiki.objects.BaseElement
      com.xpn.xwiki.objects.BaseCollection

All Implemented Interfaces:

ElementInterface, ObjectInterface, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

BaseClass, BaseObject, PropertyClass, XWikiStats

public abstract class BaseCollection
extends BaseElement
implements ObjectInterface, java.lang.Cloneable

See Also:

Serialized Form

Field Summary

protected java.lang.String	className
protected java.util.Map	fields
protected java.util.List	fieldsToRemove
protected static org.apache.commons.logging.Log	LOG
protected int	number

Constructor Summary

BaseCollection()

Method Summary

void	addField(java.lang.String name, PropertyInterface element)
void	addPropertyForRemoval(PropertyInterface field)
void	checkField(java.lang.String name)
java.lang.Object	clone()
boolean	equals(java.lang.Object coll)
PropertyInterface	get(java.lang.String name)
java.lang.String	getClassName()
java.util.Map<java.lang.String,java.lang.Object>	getCustomMappingMap()
java.util.Date	getDateValue(java.lang.String name)
java.util.List<ObjectDiff>	getDiff(java.lang.Object oldObject, XWikiContext context)
double	getDoubleValue(java.lang.String name)
PropertyInterface	getField(java.lang.String name)
java.util.Collection	getFieldList()
java.util.List	getFieldsToRemove()
float	getFloatValue(java.lang.String name)
int	getId()
int	getIntValue(java.lang.String name)
int	getIntValue(java.lang.String name, int default_value)
java.lang.String	getLargeStringValue(java.lang.String name)
java.util.List	getListValue(java.lang.String name)
long	getLongValue(java.lang.String name)
int	getNumber()
java.lang.Object[]	getProperties()
java.util.Set	getPropertyList()
java.lang.Object[]	getPropertyNames()
java.util.Set<?>	getSetValue(java.lang.String name)
java.util.Iterator	getSortedIterator() Return an iterator that will operate on a collection of values (as would be returned by getProperties or getFieldList) sorted by their name (ElementInterface.getName()).
java.lang.String	getStringValue(java.lang.String name)
BaseClass	getxWikiClass(XWikiContext context)
int	hashCode()
void	merge(BaseObject object)
void	put(java.lang.String name, PropertyInterface property)
void	removeField(java.lang.String name)
PropertyInterface	safeget(java.lang.String name)
void	safeput(java.lang.String name, PropertyInterface property)
void	setClassName(java.lang.String name)
void	setDateValue(java.lang.String name, java.util.Date value)
void	setDBStringListValue(java.lang.String name, java.util.List value)
void	setDoubleValue(java.lang.String name, double value)
void	setFields(java.util.Map fields)
void	setFieldsToRemove(java.util.List fieldsToRemove)
void	setFloatValue(java.lang.String name, float value)
void	setId(int id)
void	setIntValue(java.lang.String name, int value)
void	setLargeStringValue(java.lang.String name, java.lang.String value)
void	setLongValue(java.lang.String name, long value)
void	setNumber(int number)
void	setSetValue(java.lang.String name, java.util.Set<?> value)
void	setStringListValue(java.lang.String name, java.util.List value)
void	setStringValue(java.lang.String name, java.lang.String value)
java.lang.String	toString()
abstract org.dom4j.Element	toXML(BaseClass bclass)
java.lang.String	toXMLString()

Methods inherited from class com.xpn.xwiki.objects.BaseElement

getDocumentSyntaxId, getName, getPrettyName, getWiki, setName, setPrettyName, setWiki

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xpn.xwiki.objects.ElementInterface

getName, setName

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

className

protected java.lang.String className

fields

protected java.util.Map fields

fieldsToRemove

protected java.util.List fieldsToRemove

number

protected int number

Constructor Detail

BaseCollection

public BaseCollection()

Method Detail

getId

public int getId()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

setId

public void setId(int id)

getNumber

public int getNumber()

setNumber

public void setNumber(int number)

addPropertyForRemoval

public void addPropertyForRemoval(PropertyInterface field)

getClassName

public java.lang.String getClassName()

setClassName

public void setClassName(java.lang.String name)

checkField

public void checkField(java.lang.String name)
                throws XWikiException

Throws:

XWikiException

safeget

public PropertyInterface safeget(java.lang.String name)

Specified by:

safeget in interface ObjectInterface

See Also:

ObjectInterface.safeget(java.lang.String)

get

public PropertyInterface get(java.lang.String name)
                      throws XWikiException

Specified by:

get in interface ObjectInterface

Throws:

XWikiException

See Also:

ObjectInterface.get(java.lang.String)

safeput

public void safeput(java.lang.String name,
                    PropertyInterface property)

Specified by:

safeput in interface ObjectInterface

See Also:

ObjectInterface.safeput(java.lang.String, com.xpn.xwiki.objects.PropertyInterface)

put

public void put(java.lang.String name,
                PropertyInterface property)
         throws XWikiException

Specified by:

put in interface ObjectInterface

Throws:

XWikiException

See Also:

ObjectInterface.put(java.lang.String, com.xpn.xwiki.objects.PropertyInterface)

getxWikiClass

public BaseClass getxWikiClass(XWikiContext context)

Specified by:

getxWikiClass in interface ObjectInterface

See Also:

ObjectInterface.getxWikiClass(com.xpn.xwiki.XWikiContext)

getStringValue

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

getLargeStringValue

public java.lang.String getLargeStringValue(java.lang.String name)

setStringValue

public void setStringValue(java.lang.String name,
                           java.lang.String value)

setLargeStringValue

public void setLargeStringValue(java.lang.String name,
                                java.lang.String value)

getIntValue

public int getIntValue(java.lang.String name)

getIntValue

public int getIntValue(java.lang.String name,
                       int default_value)

setIntValue

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

getLongValue

public long getLongValue(java.lang.String name)

setLongValue

public void setLongValue(java.lang.String name,
                         long value)

getFloatValue

public float getFloatValue(java.lang.String name)

setFloatValue

public void setFloatValue(java.lang.String name,
                          float value)

getDoubleValue

public double getDoubleValue(java.lang.String name)

setDoubleValue

public void setDoubleValue(java.lang.String name,
                           double value)

getDateValue

public java.util.Date getDateValue(java.lang.String name)

setDateValue

public void setDateValue(java.lang.String name,
                         java.util.Date value)

getSetValue

public java.util.Set<?> getSetValue(java.lang.String name)

setSetValue

public void setSetValue(java.lang.String name,
                        java.util.Set<?> value)

getListValue

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

setStringListValue

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

setDBStringListValue

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

setFields

public void setFields(java.util.Map fields)

getField

public PropertyInterface getField(java.lang.String name)

addField

public void addField(java.lang.String name,
                     PropertyInterface element)

removeField

public void removeField(java.lang.String name)

getFieldList

public java.util.Collection getFieldList()

getPropertyList

public java.util.Set getPropertyList()

getProperties

public java.lang.Object[] getProperties()

getPropertyNames

public java.lang.Object[] getPropertyNames()

getSortedIterator

public java.util.Iterator getSortedIterator()

Return an iterator that will operate on a collection of values (as would be returned by getProperties or getFieldList) sorted by their name (ElementInterface.getName()).

equals

public boolean equals(java.lang.Object coll)

Overrides:

equals in class BaseElement

See Also:

BaseElement.equals(java.lang.Object)

clone

public java.lang.Object clone()

Overrides:

clone in class BaseElement

See Also:

BaseElement.clone()

merge

public void merge(BaseObject object)

getDiff

public java.util.List<ObjectDiff> getDiff(java.lang.Object oldObject,
                                          XWikiContext context)

getFieldsToRemove

public java.util.List getFieldsToRemove()

setFieldsToRemove

public void setFieldsToRemove(java.util.List fieldsToRemove)

toXML

public abstract org.dom4j.Element toXML(BaseClass bclass)

Specified by:

toXML in interface ObjectInterface

See Also:

ObjectInterface.toXML(com.xpn.xwiki.objects.classes.BaseClass)

toXMLString

public java.lang.String toXMLString()

toString

public java.lang.String toString()

Specified by:

toString in interface ElementInterface

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getCustomMappingMap

public java.util.Map<java.lang.String,java.lang.Object> getCustomMappingMap()
                                                                     throws XWikiException

Throws:

XWikiException