org.deduced.implementation
Class DocumentedCollectionImplementation

java.lang.Object
  org.deduced.AbstractPropertyCollection<K,V>
      org.deduced.FixedPropertyInstanceCollection<java.lang.Object,java.lang.Object>
          org.deduced.implementation.DocumentedCollectionImplementation

All Implemented Interfaces:

java.lang.Cloneable, DocumentedCollection, PropertyCollection<java.lang.Object,java.lang.Object>

public class DocumentedCollectionImplementation
extends FixedPropertyInstanceCollection<java.lang.Object,java.lang.Object>
implements DocumentedCollection

Java Implementation used to represent the type : documented collection Class generated by org.deduced.generator.VelocityGenerator Using template : org/deduced/generator/java/JavaImplementation.vm

Nested Class Summary

Nested classes/interfaces inherited from class org.deduced.AbstractPropertyCollection

AbstractPropertyCollection.CollectionToDeleteMonitor

Field Summary

private java.lang.String	documentation member variable holding the value for : documentation
static java.util.Set<java.lang.Object>	KEY_SET list of keys held in this collection

Fields inherited from class org.deduced.AbstractPropertyCollection

CHECK_DELETE_MODE_AUTOMATIC, CHECK_DELETE_MODE_MANUAL, COLLECTION_TO_DELETE

Fields inherited from interface org.deduced.DocumentedCollection

DOCUMENTATION_INSTANCE, DOCUMENTED_COLLECTION_TYPE

Fields inherited from interface org.deduced.PropertyCollection

PROPERTY_COLLECTION_TYPE

Constructor Summary

DocumentedCollectionImplementation()
Default constructor for the type : documented collection

Method Summary

java.util.Set<java.lang.Object>	asKeySet()
java.lang.Object	clone() (non-Javadoc)
static void	createInstancesAndTypes() create instances and types
static void	createKeyList() static method used to initialize the key list on the property collection
boolean	equals(java.lang.Object o) (non-Javadoc)
static void	fillInstancesAndTypes() fill instances and types phase 1
static void	fillInstancesAndTypesFromSchema(PropertyCollection<?,?> schema) fill instances and types from a schema
static void	fillTypeLists() fill instances and types phase 2
java.lang.String	getDocumentation() (non-Javadoc)
static java.lang.String	getDocumentation(PropertyCollection<?,?> collection) Get the value of the instance : documentation
java.lang.Object	getPropertyValue(java.lang.Object key) (non-Javadoc)
static void	resetListFixedInstances(DocumentedCollection instance) reset all the list fixed instances
static java.lang.String	setDocumentation(PropertyCollection collection, java.lang.String value) set the value of the instance : documentation
java.lang.String	setDocumentation(java.lang.String setValue) (non-Javadoc)
java.lang.Object	setProperty(java.lang.Object key, java.lang.Object value) (non-Javadoc)
PropertyCollectionType	type() (non-Javadoc)

Methods inherited from class org.deduced.FixedPropertyInstanceCollection

addProperty, areKeysAssignedAutomatically, containsKey, getProperty, iterator, iteratorByValue, removeProperty, removePropertyInstance, removePropertyValue, size

Methods inherited from class org.deduced.AbstractPropertyCollection

activate, addListener, asPropertyList, asPropertyMap, asValueList, asValueMap, callObjectClone, classLogger, cleanNewlyClonedValue, clear, clearCollectionMonitoredForDelete, cloneCollection, containsInstance, containsValue, createUniqueID, delete, deleteClearAllProperties, deleteClearListenerList, deleteFireDeleteEvent, deleteProcessCompletedValidation, deleteRemoveLocalObjectFromParent, deleteValidateEmptyListenerList, deleteValidateNoPendingReferences, firePropertyChangeEvent, flushCollectionsWithNewParent, flushCollectionsWithNewParent, getActionInvoker, getCheckDeleteMode, getCheckDeleteRunner, getFixedInstance, getInstanceIdentityKey, hashCode, id, instanceKey, internalFirePropertyChangeEvent, invokeAction, isActivated, isDeleteCheckedOnClearParent, isEmpty, isListenerRegistered, isParentOrKeyNull, keyOnParent, parent, removeListener, requiresChangeEvent, setActionInvoker, setCheckDeleteMode, setCheckDeleteRunner, setDeleteCheckedOnClearParent, setFixedInstance, setParent, toString, updateReference, updateReferenceWithReferenceFlag, validateAllPropertyInstances, validateNoListener, validateNoParentRecursion, validateParentIsNull, validateParentIsNull, valueKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deduced.PropertyCollection

activate, addListener, addProperty, areKeysAssignedAutomatically, asPropertyList, asPropertyMap, asValueList, asValueMap, clear, containsInstance, containsKey, containsValue, delete, getFixedInstance, getProperty, id, instanceKey, invokeAction, isActivated, isEmpty, isListenerRegistered, iterator, iteratorByValue, keyOnParent, parent, removeListener, removeProperty, removePropertyInstance, removePropertyValue, setFixedInstance, setParent, size, valueKey

Field Detail

KEY_SET

public static java.util.Set<java.lang.Object> KEY_SET

list of keys held in this collection

documentation

private java.lang.String documentation

member variable holding the value for : documentation

Constructor Detail

DocumentedCollectionImplementation

public DocumentedCollectionImplementation()

Default constructor for the type : documented collection

Method Detail

asKeySet

public java.util.Set<java.lang.Object> asKeySet()

Specified by:

asKeySet in interface PropertyCollection<java.lang.Object,java.lang.Object>

Returns:

the key set

type

public PropertyCollectionType type()

(non-Javadoc)

Specified by:

type in interface PropertyCollection<java.lang.Object,java.lang.Object>

Returns:

the property description

See Also:

PropertyCollection.type()

createKeyList

public static void createKeyList()

static method used to initialize the key list on the property collection

getDocumentation

public java.lang.String getDocumentation()

(non-Javadoc)

Specified by:

getDocumentation in interface DocumentedCollection

Returns:

documentation

See Also:

DocumentedCollection.getDocumentation()

getDocumentation

public static java.lang.String getDocumentation(PropertyCollection<?,?> collection)

Get the value of the instance : documentation

Parameters:

collection - new collection from which to fetch the value

Returns:

documentation

setDocumentation

public java.lang.String setDocumentation(java.lang.String setValue)

(non-Javadoc)

Specified by:

setDocumentation in interface DocumentedCollection

Parameters:

setValue - new documentation

Returns:

documentation value after the change

See Also:

DocumentedCollection.setDocumentation(java.lang.String)

setDocumentation

public static java.lang.String setDocumentation(PropertyCollection collection,
                                                java.lang.String value)

set the value of the instance : documentation

Parameters:

collection - new collection on which to set the value

value - new value for : documentation

Returns:

documentation

equals

public boolean equals(java.lang.Object o)

(non-Javadoc)

Overrides:

equals in class AbstractPropertyCollection<java.lang.Object,java.lang.Object>

See Also:

Object.equals(java.lang.Object)

clone

public java.lang.Object clone()

(non-Javadoc)

Specified by:

clone in interface PropertyCollection<java.lang.Object,java.lang.Object>

Overrides:

clone in class AbstractPropertyCollection<java.lang.Object,java.lang.Object>

Returns:

the object clone

See Also:

AbstractPropertyCollection.clone()

setProperty

public java.lang.Object setProperty(java.lang.Object key,
                                    java.lang.Object value)

(non-Javadoc)

Specified by:

setProperty in interface PropertyCollection<java.lang.Object,java.lang.Object>

Overrides:

setProperty in class FixedPropertyInstanceCollection<java.lang.Object,java.lang.Object>

Parameters:

key - the key of the property

value - the new value of the property. If the property is a collection that is not by reference, this method requires that the passed collection has a parent set to null since it will reset the parent.

Returns:

the added value instance

See Also:

PropertyCollection.setProperty(java.lang.Object,java.lang.Object)

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.Object key)

(non-Javadoc)

Specified by:

getPropertyValue in interface PropertyCollection<java.lang.Object,java.lang.Object>

Parameters:

key - the property key

Returns:

the property value, null if the get failed

See Also:

PropertyCollection.getPropertyValue(java.lang.Object)

resetListFixedInstances

public static void resetListFixedInstances(DocumentedCollection instance)

reset all the list fixed instances

Parameters:

instance - the instance that will get all its list fixed instances set

createInstancesAndTypes

public static void createInstancesAndTypes()

create instances and types

fillInstancesAndTypesFromSchema

public static void fillInstancesAndTypesFromSchema(PropertyCollection<?,?> schema)

fill instances and types from a schema

Parameters:

schema - the schema that contains the required instances and types

fillInstancesAndTypes

public static void fillInstancesAndTypes()

fill instances and types phase 1

fillTypeLists

public static void fillTypeLists()

fill instances and types phase 2