com.xpn.xwiki.objects.meta
Class PropertyMetaClass

java.lang.Object
  extended by com.xpn.xwiki.objects.BaseElement<R>
      extended by com.xpn.xwiki.objects.BaseCollection<DocumentReference>
          extended by com.xpn.xwiki.objects.classes.BaseClass
              extended by com.xpn.xwiki.objects.meta.PropertyMetaClass
All Implemented Interfaces:
com.xpn.xwiki.internal.objects.classes.PropertyClassProvider, com.xpn.xwiki.internal.objects.meta.PropertyMetaClassInterface, ClassInterface, ElementInterface, ObjectInterface, PropertyInterface, Serializable, Cloneable
Direct Known Subclasses:
BooleanMetaClass, ComputedFieldMetaClass, DateMetaClass, ListMetaClass, NumberMetaClass, StringMetaClass

public class PropertyMetaClass
extends BaseClass
implements com.xpn.xwiki.internal.objects.meta.PropertyMetaClassInterface, com.xpn.xwiki.internal.objects.classes.PropertyClassProvider

Default implementation of PropertyMetaClassInterface. Provides the default set of meta properties all XClass properties have. Can be extended by adding new meta properties with BaseCollection.safeput(String, com.xpn.xwiki.objects.PropertyInterface).

NOTE: We implement PropertyClassProvider in order to be able to use existing meta classes (that extend this one) as providers while keeping backward compatibility. When defining new property types you should not extend this class but rather create a new PropertyClassProvider that creates an instance of this class and adds new meta properties using BaseCollection.safeput(String, com.xpn.xwiki.objects.PropertyInterface).

Version:
$Id: b8191ddffd7f3f50372df58f62ecb6bcda01a51e $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.xpn.xwiki.objects.BaseCollection
currentReferenceDocumentReferenceResolver, fields, fieldsToRemove, number, relativeEntityReferenceResolver
 
Fields inherited from class com.xpn.xwiki.objects.BaseElement
documentReference, localEntityReferenceSerializer, ownerDocument, referenceCache
 
Constructor Summary
PropertyMetaClass()
          Default constructor.
 
Method Summary
 PropertyMetaClass clone()
           
 com.xpn.xwiki.internal.objects.meta.PropertyMetaClassInterface getDefinition()
           
 PropertyClassInterface getInstance()
           
 BaseCollection getObject()
           
 BaseCollection newObject(XWikiContext context)
          
 void setObject(BaseCollection object)
           
 String toFormString()
           
 
Methods inherited from class com.xpn.xwiki.objects.classes.BaseClass
addBooleanField, addDateField, addDateField, addDateField, addDBListField, addDBListField, addDBListField, addDBTreeListField, addDBTreeListField, addDBTreeListField, addEmailField, addField, addGroupsField, addGroupsField, addLevelsField, addLevelsField, addNumberField, addPasswordField, addStaticListField, addStaticListField, addStaticListField, addStaticListField, addStaticListField, addTemplateField, addTextAreaField, addTextField, addUsersField, addUsersField, addUsersField, addUsersField, apply, disableField, enableField, equals, flushCache, fromMap, fromMap, fromString, fromValueMap, fromXML, fromXML, get, getCustomClass, getCustomMapping, getCustomMappingPropertyList, getDefaultEditSheet, getDefaultViewSheet, getDefaultWeb, getDeprecatedObjectProperties, getDiff, getDisabledObjectProperties, getDisabledProperties, getEnabledProperties, getName, getNameField, getReference, getValidationScript, hasCustomMapping, hasExternalCustomMapping, hasInternalCustomMapping, isCustomMappingValid, isCustomMappingValid, merge, merge, newCustomClassInstance, newCustomClassInstance, newCustomClassInstance, put, setCustomClass, setCustomMapping, setDefaultEditSheet, setDefaultViewSheet, setDefaultWeb, setDirty, setName, setNameField, setOwnerDocument, setValidationScript, toXML, toXML, validateObject
 
Methods inherited from class com.xpn.xwiki.objects.BaseCollection
addPropertyForRemoval, getClassName, getCustomMappingMap, getDateValue, getDoubleValue, getField, getFieldList, getFieldsToRemove, getFloatValue, getIntValue, getIntValue, getLargeStringValue, getListValue, getLongValue, getNumber, getProperties, getPropertyList, getPropertyNames, getRelativeXClassReference, getSetValue, getSortedIterator, getStringValue, getXClass, getXClassReference, merge, removeField, safeget, safeput, setClassName, setDateValue, setDBStringListValue, setDocumentReference, setDoubleValue, setFields, setFieldsToRemove, setFloatValue, setIntValue, setLargeStringValue, setLongValue, setNumber, setSetValue, setStringListValue, setStringValue, setXClassReference, toString, toXMLString
 
Methods inherited from class com.xpn.xwiki.objects.BaseElement
createReference, getDocumentReference, getId, getLocalKey, getLocalUidStringEntityReferenceSerializer, getOwnerDocument, getPrettyName, hashCode, setId, setPrettyName
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.xpn.xwiki.objects.ObjectInterface
get, getXClass, put, safeget, safeput, toXML
 
Methods inherited from interface com.xpn.xwiki.objects.ElementInterface
apply, getDocumentReference, getName, getReference, merge, setDocumentReference, setName, toString
 
Methods inherited from interface com.xpn.xwiki.objects.PropertyInterface
getId, setId, toXML
 

Constructor Detail

PropertyMetaClass

public PropertyMetaClass()
Default constructor. Initializes the meta properties that are common to all XClass property types.

Method Detail

getObject

public BaseCollection getObject()
Specified by:
getObject in interface PropertyInterface

setObject

public void setObject(BaseCollection object)
Specified by:
setObject in interface PropertyInterface

toFormString

public String toFormString()
Specified by:
toFormString in interface PropertyInterface

clone

public PropertyMetaClass clone()
Specified by:
clone in interface PropertyInterface
Overrides:
clone in class BaseClass

newObject

public BaseCollection newObject(XWikiContext context)
                         throws XWikiException

This method is deprecated. Use directly the PropertyClassProvider if you need a new XClass property instance.

Overrides:
newObject in class BaseClass
Throws:
XWikiException

getInstance

public PropertyClassInterface getInstance()
Specified by:
getInstance in interface com.xpn.xwiki.internal.objects.classes.PropertyClassProvider

getDefinition

public com.xpn.xwiki.internal.objects.meta.PropertyMetaClassInterface getDefinition()
Specified by:
getDefinition in interface com.xpn.xwiki.internal.objects.classes.PropertyClassProvider


Copyright © 2004–2014 XWiki. All rights reserved.