|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.evolveum.midpoint.schema.processor.Definition
com.evolveum.midpoint.schema.processor.ItemDefinition
com.evolveum.midpoint.schema.processor.PropertyDefinition
public class PropertyDefinition
Property Definition.
Property is a basic unit of information in midPoint. This class provides definition of property type, multiplicity and so on. Property is a specific characteristic of an object. It may be considered object "attribute" or "field". For example User has fullName property that contains string value of user's full name. Properties may be single-valued or multi-valued Properties may contain primitive types or complex types (defined by XSD schema) Property values are unordered, implementation may change the order of values Duplicate values of properties should be silently removed by implementations, but clients must be able tolerate presence of duplicate values. Operations that modify the objects work with the granularity of properties. They add/remove/replace the values of properties, but do not "see" inside the property. This class represents schema definition for property. SeeDefinition
for more details.
Field Summary |
---|
Fields inherited from class com.evolveum.midpoint.schema.processor.ItemDefinition |
---|
name |
Fields inherited from class com.evolveum.midpoint.schema.processor.Definition |
---|
defaultName, displayName, help, ignored, typeName |
Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable |
---|
INDENT_STRING |
Constructor Summary | |
---|---|
PropertyDefinition(javax.xml.namespace.QName name,
javax.xml.namespace.QName typeName)
|
|
PropertyDefinition(javax.xml.namespace.QName name,
javax.xml.namespace.QName defaultName,
javax.xml.namespace.QName typeName)
|
Method Summary | |
---|---|
boolean |
canCreate()
|
boolean |
canRead()
TODO: |
boolean |
canUpdate()
TODO: |
boolean |
equals(java.lang.Object obj)
|
java.lang.Object[] |
getAllowedValues()
Returns allowed values for this property. |
int |
getMaxOccurs()
Return the number of maximal value occurrences. |
int |
getMinOccurs()
Return the number of minimal value occurrences. |
javax.xml.namespace.QName |
getValueType()
Returns QName of the property value type. |
int |
hashCode()
|
Property |
instantiate(PropertyPath parentPath)
Create an item instance. |
Property |
instantiate(javax.xml.namespace.QName name,
java.lang.Object element,
PropertyPath parentPath)
Create an item instance. |
Property |
instantiate(javax.xml.namespace.QName name,
PropertyPath parentPath)
Create an item instance. |
boolean |
isMandatory()
Returns true if property is mandatory. |
boolean |
isMultiValue()
Returns true if property is multi-valued. |
boolean |
isOptional()
Returns true if property is optional. |
boolean |
isSingleValue()
Returns true if property is single-valued. |
Property |
parseFromValueElement(org.w3c.dom.Element valueElement,
PropertyPath parentPath)
|
Property |
parseItem(java.util.List<java.lang.Object> elements,
PropertyPath parentPath)
Create at instance of the item initialized from the provided list of elements. |
Property |
parseItemFromJaxbObject(java.lang.Object jaxbObject,
PropertyPath parentPath)
|
void |
setCreate(boolean create)
|
void |
setMaxOccurs(int maxOccurs)
|
void |
setMinOccurs(int minOccurs)
|
void |
setRead(boolean read)
|
void |
setReadOnly()
|
void |
setUpdate(boolean update)
|
java.lang.String |
toString()
|
Methods inherited from class com.evolveum.midpoint.schema.processor.ItemDefinition |
---|
copyDefinitionData, getName, getNameOrDefaultName, setName |
Methods inherited from class com.evolveum.midpoint.schema.processor.Definition |
---|
copyDefinitionData, debugDump, debugDump, dump, getDefaultName, getDisplayName, getHelp, getTypeName, isIgnored, setDisplayName, setHelp, setIgnored |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PropertyDefinition(javax.xml.namespace.QName name, javax.xml.namespace.QName defaultName, javax.xml.namespace.QName typeName)
public PropertyDefinition(javax.xml.namespace.QName name, javax.xml.namespace.QName typeName)
Method Detail |
---|
public java.lang.Object[] getAllowedValues()
public boolean canRead()
public boolean canUpdate()
public void setReadOnly()
public javax.xml.namespace.QName getValueType()
public int getMinOccurs()
public void setMinOccurs(int minOccurs)
public int getMaxOccurs()
public void setMaxOccurs(int maxOccurs)
public boolean isSingleValue()
public boolean isMultiValue()
public boolean isMandatory()
public boolean isOptional()
public Property instantiate(PropertyPath parentPath)
ItemDefinition
instantiate
in class ItemDefinition
public Property instantiate(javax.xml.namespace.QName name, PropertyPath parentPath)
ItemDefinition
instantiate
in class ItemDefinition
public Property instantiate(javax.xml.namespace.QName name, java.lang.Object element, PropertyPath parentPath)
ItemDefinition
instantiate
in class ItemDefinition
public void setRead(boolean read)
public void setUpdate(boolean update)
public void setCreate(boolean create)
public boolean canCreate()
public Property parseItem(java.util.List<java.lang.Object> elements, PropertyPath parentPath) throws SchemaException
ItemDefinition
parseItem
in class ItemDefinition
elements
- content of the item
SchemaException
- error parsing the provided elementspublic java.lang.String toString()
toString
in class ItemDefinition
public Property parseFromValueElement(org.w3c.dom.Element valueElement, PropertyPath parentPath) throws SchemaException
SchemaException
public Property parseItemFromJaxbObject(java.lang.Object jaxbObject, PropertyPath parentPath) throws SchemaException
parseItemFromJaxbObject
in class ItemDefinition
SchemaException
public int hashCode()
hashCode
in class ItemDefinition
public boolean equals(java.lang.Object obj)
equals
in class ItemDefinition
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |