de.grogra.pf.registry
Class Option

java.lang.Object
  de.grogra.graph.impl.Edge
      de.grogra.graph.impl.Node
          de.grogra.pf.registry.Item
              de.grogra.pf.registry.ObjectItem
                  de.grogra.pf.registry.LazyObjectItem
                      de.grogra.pf.registry.Value
                          de.grogra.pf.registry.Option

All Implemented Interfaces:

Manageable, PersistenceCapable, Shareable, SharedObjectProvider, RegistryContext, UserFields, XObject, Described, KeyDescription, Map, java.io.Serializable

public class Option
extends Value
implements KeyDescription

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.grogra.graph.impl.Node

Node.AccessorBridge, Node.FieldAttributeAccessor, Node.NType

Nested classes/interfaces inherited from interface de.grogra.persistence.SharedObjectProvider

SharedObjectProvider.Binding

Nested classes/interfaces inherited from interface de.grogra.util.Map

Map.Chain

Field Summary

static Node.NType

$TYPE

Fields inherited from class de.grogra.pf.registry.Value

value$FIELD

Fields inherited from class de.grogra.pf.registry.LazyObjectItem

fetch$FIELD

Fields inherited from class de.grogra.pf.registry.ObjectItem

objDescribes$FIELD, type$FIELD, USED_BITS

Fields inherited from class de.grogra.graph.impl.Node

ADDITIONAL_FIELDS, bits, DELETED, EXTENT_BIT, EXTENT_MASK, extentIndex$FIELD, extentTail$FIELD, HAS_OBSERVERS, IS_INTERPRETIVE, isInterpretive$FIELD, LAST_EXTENT_INDEX, layer$FIELD, MARK, mark$FIELD, MIME_TYPE, MIN_UNUSED_SPECIAL_OF_SOURCE, MIN_UNUSED_SPECIAL_OF_TARGET, name$FIELD

Fields inherited from interface de.grogra.util.Described

ACCELERATOR_KEY, ICON, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, TITLE

Fields inherited from interface de.grogra.util.Map

DEFAULT_VALUE, EMPTY_MAP

Constructor Summary

Option()

Method Summary

protected void	activateImpl()
boolean	belongsToGroup(Item item)
static Option	createNoneditableOption(java.lang.String name, java.lang.Object value)
static Option	get(Item item, java.lang.String option)
static Option[]	getEditableOptions(Item i, boolean includeTransient) Returns all options in the subtree starting with i which are editable or transient (the latter only if includeTransient is true).
java.lang.String	getKey() Returns the key which is described by this instance.
protected Node.NType	getNTypeImpl() This method returns the Node.NType which describes the managed fields of the class of this node.
static java.lang.String	getPreference(Item item)
Quantity	getQuantity() Returns the quantity of values which are associated with the key.
Type	getType() Returns the type of values which are associated with the key.
protected boolean	getTypeFromObject()
static boolean	hasEditableOptions(Item item)
boolean	isEditable()
boolean	isTransient()
protected Node	newInstance() This method returns a new instance of the class of this node.
protected boolean	readAttribute(java.lang.String uri, java.lang.String name, java.lang.String value)
void	setOptionValue(java.lang.Object value)
static void	setPreference(Item item, java.lang.String value)

Methods inherited from class de.grogra.pf.registry.Value

fetchBaseObject, getAttributes, hasNullValue, setValue

Methods inherited from class de.grogra.pf.registry.LazyObjectItem

addPluginPrerequisites, getBaseObjectImpl, getObject, isObjectFetched, setBaseObject

Methods inherited from class de.grogra.pf.registry.ObjectItem

addToRegistry, createReference, getDerivedDescription, getObjectType, getProviderName, isInstance, isInstance, isInstance, readReference, setObjDescribes, setType, writeObject

Methods inherited from class de.grogra.pf.registry.Item

activate, add, add, addPluginPrerequisite, addRequiredFiles, addUserItem, addUserItemWithUniqueName, addWithUniqueName, beginXA, classForName, commitXA, createItem, deactivate, deactivateImpl, deriveItems, dupUnmanagedFields, equals, findAll, findAll, findAll, findFirst, findFirst, findFirst, findMax, findMax, findMax, forAll, forAll, forAll, get, getAbsoluteName, getAccessor, getAccessor, getAttributes, getClassLoader, getDefaultDescription, getDefaultValue, getDescription, getDescriptionImpl, getFromResource, getI18NBundle, getItem, getLock, getParentMap, getPath, getPluginDescriptor, getRegistry, getRoot, getTransaction, getUniqueName, getWriteLock, hasEditableOptions, initPluginDescriptor, isActivated, isDirectory, isEditable, isOptionCategory, isPluginItem, isUserItem, makeUserItem, paramString, remove, removeDerivedItems, resolveItem, resolveLink, set, setDefaultDescription, setDescription, setDescription, setDirectory, setName, setNameIfNull, setOption, substitute, validate

Methods inherited from class de.grogra.graph.impl.Node

addEdgeBitsTo, addReference, appendBranchNode, appendBranchNode, appendReferencesTo, clone, clone, cloneGraph, dump, dumpTree, dup, edgeChanged, fieldModified, findAdjacent, getAxisParent, getBoolean, getBranch, getBranchLength, getBranchNode, getBranchTail, getByte, getChar, getCommonAncestor, getCurrentGraphState, getDirectChildCount, getDouble, getEdgeAttributeAccessor, getEdgeAttributes, getEdgeBitsTo, getEdgeTo, getExtentIndex, getFirst, getFirstEdge, getFloat, getGraph, getId, getIndex, getInstantiator, getInt, getLayer, getLong, getManageableType, getName, getNeighbor, getNext, getNType, getObject, getOrCreateEdgeTo, getOrNull, getPersistenceManager, getPredecessor, getProvider, getShort, getSource, getStamp, getSuccessor, getSymbol, getSymbolColor, getTarget, getTransaction, getUserField, getUserFieldCount, getXClass, getXData, hasName, initProvider, initXClass, insertBranchNode, insertBranchNode, instantiateGraph, isAncestorOf, isDirection, isManagingInstance, isMarked, isRoot, isSource, isTarget, manageableReadResolve, manageableWriteReplace, removeAll, removeEdgeBitsTo, removeFromChain, removeFromChain, removeReference, setBranch, setBranch, setExtentIndex, setGraphForDeserialization, setLayer, setMark, setSuccessor, setSuccessor, specialEdgeAdded, specialEdgeRefModified, specialEdgeRemoved, toString, writeReplace

Methods inherited from class de.grogra.graph.impl.Edge

addEdgeBits, getBitMark, getEdgeBits, getObjectMark, getSpecialEdgeDescriptor, parseEdgeKeys, remove, removeEdgeBits, setBitMark, setEdgeBits, setObjectMark, testEdgeBits

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.grogra.util.Described

getDescription

Methods inherited from interface de.grogra.persistence.PersistenceCapable

getBitMark, getObjectMark, setBitMark, setObjectMark

Field Detail

$TYPE

public static final Node.NType $TYPE

Constructor Detail

Option

public Option()

Method Detail

activateImpl

protected void activateImpl()

Overrides:

activateImpl in class Item

belongsToGroup

public boolean belongsToGroup(Item item)

createNoneditableOption

public static Option createNoneditableOption(java.lang.String name,
                                             java.lang.Object value)

get

public static Option get(Item item,
                         java.lang.String option)

getEditableOptions

public static Option[] getEditableOptions(Item i,
                                          boolean includeTransient)

Returns all options in the subtree starting with i which are editable or transient (the latter only if includeTransient is true). Links having the name "option" are resolved.

Parameters:

i - the item to start with

includeTransient - include transient options?

Returns:

an array of all editable options in the subtree starting with i

getKey

public java.lang.String getKey()

Description copied from interface: KeyDescription

Returns the key which is described by this instance.

Specified by:

getKey in interface KeyDescription

Returns:

the key

getNTypeImpl

protected Node.NType getNTypeImpl()

Description copied from class: Node

This method returns the Node.NType which describes the managed fields of the class of this node. This method has to be implemented in every concrete subclass.

Overrides:

getNTypeImpl in class Value

Returns:

type describing the managed fields of the class of this node

getPreference

public static java.lang.String getPreference(Item item)

getQuantity

public Quantity getQuantity()

Description copied from interface: KeyDescription

Returns the quantity of values which are associated with the key.

Specified by:

getQuantity in interface KeyDescription

Returns:

the quantity of values

getType

public Type getType()

Description copied from interface: KeyDescription

Returns the type of values which are associated with the key.

Specified by:

getType in interface KeyDescription

Returns:

the type of values

getTypeFromObject

protected boolean getTypeFromObject()

Overrides:

getTypeFromObject in class LazyObjectItem

hasEditableOptions

public static boolean hasEditableOptions(Item item)

isEditable

public boolean isEditable()

isTransient

public boolean isTransient()

newInstance

protected Node newInstance()

Description copied from class: Node

This method returns a new instance of the class of this node. This method has to be implemented in every concrete subclass.

Overrides:

newInstance in class Value

Returns:

new instance of class of this node

readAttribute

protected boolean readAttribute(java.lang.String uri,
                                java.lang.String name,
                                java.lang.String value)
                         throws org.xml.sax.SAXException

Overrides:

readAttribute in class Value

Throws:

org.xml.sax.SAXException

setOptionValue

public void setOptionValue(java.lang.Object value)

setPreference

public static void setPreference(Item item,
                                 java.lang.String value)