| net.sf.jmoney.model2.ExtendablePropertySet
| ExtendablePropertySet | | public class ExtendablePropertySet extends PropertySet (Code) | | |
| Method Summary | |
| public void | addPage(PageEntry newPage)
| | public E | constructDefaultImplementationObject(IObjectKey objectKey, ListKey<? super E> parentKey)
This method should be used only by plug-ins that implement
a datastore.
A newly constructed object, constructed from the givenparameters. | | public E | constructImplementationObject(IObjectKey objectKey, ListKey<? super E> parentKey, IValues values)
This method should be used only by plug-ins that implement
a datastore.
Parameters:
constructorParameters - an array of values to be passed tothe constructor. | | public ExtendablePropertySet<? extends E> | getActualPropertySet(Class<? extends E> classOfObject)
Given a class of an object, returns the property
set for that object. | | public ExtendablePropertySet<? super E> | getBasePropertySet()
| | public Collection<ExtendablePropertySet<? extends E>> | getDerivedPropertySets()
| | public Collection<ExtensionPropertySet<?>> | getDirectExtensionPropertySets()
Gets a list of all property sets that extend the given property
set. | | public Collection<ExtendablePropertySet<? extends E>> | getDirectlyDerivedPropertySets()
Gets the set of all property sets that are directly derived from this
property set. | | public Collection<ExtensionPropertySet<?>> | getExtensionPropertySets()
Gets a list of all property sets that extend the given property set. | | public Image | getIcon()
This method creates the image on first call. | | String | getIconFileName()
| | protected E | getImplementationObject(ExtendableObject extendableObject)
| | public Collection<ListPropertyAccessor> | getListProperties2()
Returns the set of all list properties (i.e. | | public Collection<ListPropertyAccessor> | getListProperties3()
Returns the same set of properties as the getProperties3
method but the returned collection includes only the list properties
(i.e. | | public ListPropertyAccessor | getListProperty(String listPropertyId)
Utility method to find a property among all properties supported
by objects of this class. | | public String | getObjectDescription()
| | public Vector<PageEntry> | getPageFactories()
Returns the set of tabbed pages that are to be shown in the
editor associated with extendable objects of this property set. | | public Collection<PropertyAccessor> | getProperties3()
Returns the set of all properties of the given set of property sets,
including properties in the extendable object, properties in extension
property sets, and all properties in the base property sets including all
extension properties to the base property sets.
This is the set of properties that can be set against an object that
implements this property set.
Properties are returned with the properties from the base-most class
first, then properties from the class immediately derived from the
base-most class, and so on with the properties from this property set
being last. | | public PropertyAccessor | getPropertyAccessorGivenLocalNameAndExcludingExtensions(String localPropertyName)
Gets the accessor for a property given the local name of the property.
This method searches only this property set and any base
property sets. | | public Collection<ScalarPropertyAccessor> | getScalarProperties2()
Returns the set of all scalar properties (i.e. | | public Collection<ScalarPropertyAccessor> | getScalarProperties3()
Returns the same set of properties as the getProperties3
method but the returned collection includes only the scalar properties
(i.e. | | public ScalarPropertyAccessor | getScalarProperty(String scalarPropertyId)
Utility method to find a property among all properties supported
by objects of this class. | | public void | initProperties(String propertySetId)
| | public void | initPropertiesPass2()
| | public boolean | isDerivable()
| | public void | setIcon(String iconFileName)
Set an icon that is to be shown for objects of this class. |
| constructors | | IExtendableObjectConstructors<E> constructors(Code) | | An interface that can be used to construct implementation objects,
or null if this is an abstract property set.
|
| derivable | | protected boolean derivable(Code) | | true if further property sets must be derived from this property set,
false if property sets cannot be derived from this property set.
|
| iconFileName | | protected String iconFileName(Code) | | This field is valid for extendable property sets only
|
| objectDescription | | protected String objectDescription(Code) | | Localized text describing the type of object represented
by this property set. This property is never null.
|
| ExtendablePropertySet | | protected ExtendablePropertySet(Class<E> classOfObject, String objectDescription, ExtendablePropertySet<? super E> basePropertySet, IExtendableObjectConstructors<E> constructors)(Code) | | Constructs a property set object.
Parameters:
classOfObject - the class of the implementation object
Parameters:
objectDescription - a localized description of this object class, suitable for usein the UI
Parameters:
basePropertySet - the property set from which this property set is derived, ornull if we are constructing a base property set
Parameters:
constructors - an interface containing methods for constructingimplementation objects, or null if this is an abstractproperty set |
| constructDefaultImplementationObject | | public E constructDefaultImplementationObject(IObjectKey objectKey, ListKey<? super E> parentKey)(Code) | | This method should be used only by plug-ins that implement
a datastore.
A newly constructed object, constructed from the givenparameters. This object may be an ExtendableObject ormay be an ExtensionObject. |
| constructImplementationObject | | public E constructImplementationObject(IObjectKey objectKey, ListKey<? super E> parentKey, IValues values)(Code) | | This method should be used only by plug-ins that implement
a datastore.
Parameters:
constructorParameters - an array of values to be passed tothe constructor. If an extendable object is being constructedthen the first three elements of this array must be theobject key, the extension map, and the parent object key. A newly constructed object, constructed from the givenparameters. This object may be an ExtendableObject ormay be an ExtensionObject. |
| getActualPropertySet | | public ExtendablePropertySet<? extends E> getActualPropertySet(Class<? extends E> classOfObject)(Code) | | Given a class of an object, returns the property
set for that object. The class passed to this method
must be the class of an ExtendableObject that either is
the implementation object for this property set or is
extended from the implemetation class. The class must be
a final class (i.e. a class of an actual object instance,
not an abstract class).
If this property set is a final property set then this
method will always return this object.
the final property set |
| getBasePropertySet | | public ExtendablePropertySet<? super E> getBasePropertySet()(Code) | | If this property set is derived from another propertyset then the base property set is returned, otherwisenull is returned. |
| getDerivedPropertySets | | public Collection<ExtendablePropertySet<? extends E>> getDerivedPropertySets()(Code) | | the set of all property setsthat are derived from this property set andthat are themselves not derivable |
| getDirectExtensionPropertySets | | public Collection<ExtensionPropertySet<?>> getDirectExtensionPropertySets()(Code) | | Gets a list of all property sets that extend the given property
set. This method is used by the Propagator class only.
Note:
This method does not return derived property sets.
This method does not return property sets that extend any
property sets from which this property set is derived.
the extension property sets that extend this propertyset |
| getDirectlyDerivedPropertySets | | public Collection<ExtendablePropertySet<? extends E>> getDirectlyDerivedPropertySets()(Code) | | Gets the set of all property sets that are directly derived from this
property set. This set does not include property sets that are derived
from property sets that are in turn derived from this property set. This
set includes both property sets that are derivable and property sets that
are final.
This method is useful when the caller needs to know the actual tree
structure of the derived property sets or needs to know about the
intermediate (non-final) property sets. Callers generally would call this
method in a recursive manner.
If a caller just needs a list of the final property sets,
getDerivedPropertySets() is simpler to use.
|
| getExtensionPropertySets | | public Collection<ExtensionPropertySet<?>> getExtensionPropertySets()(Code) | | Gets a list of all property sets that extend the given property set.
Property sets that extend any base property sets are also included.
Note: This method does not return derived property sets.
the extension property sets that extend this property set |
| getIcon | | public Image getIcon()(Code) | | This method creates the image on first call. It is very
important that the image is not created when the this PropertySet
object is initialized. The reason is that this PropertySet is
initialized by a different thread than the UI thread. Images
must be created by UI thread.
This method is valid for extendable property sets only.
the icon associated with objects that implementthis property set. |
| getIconFileName | | String getIconFileName()(Code) | | used internally
|
| getListProperties2 | | public Collection<ListPropertyAccessor> getListProperties2()(Code) | | Returns the set of all list properties (i.e. scalar properties are
excluded) of the given set of property sets, including both properties in
the extendable object and properties in extension property sets.
Properties from base property sets and properties from derived property
sets are not returned.
a collection of PropertyAccessor objects |
| getListProperties3 | | public Collection<ListPropertyAccessor> getListProperties3()(Code) | | Returns the same set of properties as the getProperties3
method but the returned collection includes only the list properties
(i.e. scalar properties are excluded).
|
| getListProperty | | public ListPropertyAccessor getListProperty(String listPropertyId)(Code) | | Utility method to find a property among all properties supported
by objects of this class.
Parameters:
listPropertyId - |
| getObjectDescription | | public String getObjectDescription()(Code) | | localized text describing the type of objectrepresented by this property set |
| getPageFactories | | public Vector<PageEntry> getPageFactories()(Code) | | Returns the set of tabbed pages that are to be shown in the
editor associated with extendable objects of this property set.
This method is valid only for non-derivable extendable property sets.
a set of objects of type PageEntry |
| getProperties3 | | public Collection<PropertyAccessor> getProperties3()(Code) | | Returns the set of all properties of the given set of property sets,
including properties in the extendable object, properties in extension
property sets, and all properties in the base property sets including all
extension properties to the base property sets.
This is the set of properties that can be set against an object that
implements this property set.
Properties are returned with the properties from the base-most class
first, then properties from the class immediately derived from the
base-most class, and so on with the properties from this property set
being last. This order gives the most intuitive order from the user's
perspective. This order also ensures that a property in a base class has
the same index in the returned order, regardless of the actual derived
property set.
|
| getPropertyAccessorGivenLocalNameAndExcludingExtensions | | public PropertyAccessor getPropertyAccessorGivenLocalNameAndExcludingExtensions(String localPropertyName) throws PropertyNotFoundException(Code) | | Gets the accessor for a property given the local name of the property.
This method searches only this property set and any base
property sets. No extensions are searched.
This method is used when a column name is persisted in, say, a file
and we are keen to keep the data in the file as simple and short as
possible. We therefore allow local names only to be specified.
Local names may not be unique when extensions are included, so we
must require fully qualified names for extensions.
Parameters:
name - The local property name |
| getScalarProperties2 | | public Collection<ScalarPropertyAccessor> getScalarProperties2()(Code) | | Returns the set of all scalar properties (i.e. list properties are
excluded) of the given set of property sets, including both properties in
the extendable object and properties in extension property sets.
Properties from base property sets and properties from derived property
sets are not returned.
a collection of PropertyAccessor objects |
| getScalarProperties3 | | public Collection<ScalarPropertyAccessor> getScalarProperties3()(Code) | | Returns the same set of properties as the getProperties3
method but the returned collection includes only the scalar properties
(i.e. list properties are excluded).
|
| getScalarProperty | | public ScalarPropertyAccessor getScalarProperty(String scalarPropertyId)(Code) | | Utility method to find a property among all properties supported
by objects of this class.
Parameters:
scalarPropertyId - |
| initProperties | | public void initProperties(String propertySetId)(Code) | | |
| initPropertiesPass2 | | public void initPropertiesPass2()(Code) | | |
| isDerivable | | public boolean isDerivable()(Code) | | True if this property set can only be used byderiving another property set from it, falseif property sets cannot be derived from thisproperty set. |
| setIcon | | public void setIcon(String iconFileName)(Code) | | Set an icon that is to be shown for objects of this class.
If no icon is set then the icon for the base class will be
used or, if there is no base class, no icon will be shown
for objects of this class.
Parameters:
iconFileName - |
|
|