|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HierarchicalEntity
HierarchicalEntity extends ConfigurableEntity by describing an interface by which Entities can be included in a hierachy of successors. The resulting hierarchy is searched upward when getting Properties. This design pattern models the Chain of Responsibility Pattern (Gamma et al).
For example, if an entity A has a successor entity B, and A is queried for a property but does not have a value persisted for that property, it will lookup entity B and query it for that property.
Also, "explicit" successors can be specified as part of a getProperty method call. These are other ConfigurableEntities that should be queried after the current entity, but before any persisted successors.
A HierarchicalEntity can have one successor persisted for each property set, as well as a "default" successor that is not associated with a property set. The default successor will be queried in the case that the current entity does not have a value, the explicit successor (if one is specified) does not have a value, and the successor for the property's property set does not have a value.
Field Summary | |
---|---|
static String |
SUCCESSOR
property name for an entity's successor |
Fields inherited from interface com.bea.p13n.property.ConfigurableEntity |
---|
RESERVED_PROPERTY_SET |
Method Summary | |
---|---|
Object |
getProperty(String propertySet,
String propertyName,
ConfigurableEntity successor)
Retrieve the value associated with the named key in the specified property set. |
String |
getPropertyAsString(String propertySet,
String propertyName,
ConfigurableEntity successor)
Convenience method to return the property as a String. |
Object |
getPropertyNoDefault(String propertySet,
String propertyName,
ConfigurableEntity successor)
Retrieve the value associated with the property in the specified property set, but does not return a default value from the property's PropertyDefinition if the property does not exist for the entity or in the hierarchy of successors. |
ConfigurableEntity |
getSuccessor(String propertySet)
Retrieve the successor for the specified property set. |
void |
removeSuccessor(String propertySet)
Remove the successor for the specified property set |
void |
setSuccessor(String propertySet,
ConfigurableEntity successor)
Set the successor for the specified property set |
Methods inherited from interface com.bea.p13n.property.ConfigurableEntity |
---|
getJndiName, getPkString, getProperty, getPropertyAsString, getPropertyNoDefault, getUniqueId, removeProperty, setProperty |
Field Detail |
---|
static final String SUCCESSOR
Method Detail |
---|
Object getProperty(String propertySet, String propertyName, ConfigurableEntity successor) throws RemoteException
propertySet
- The name of the property setpropertyName
- The name of the property to retrieve.successor
- The explicit successor to use for sucessor hiearchy
search if the entity does not have the property defined.
RemoteException
String getPropertyAsString(String propertySet, String propertyName, ConfigurableEntity successor) throws RemoteException
propertySet
- The name of the property setpropertyName
- The name of the property to retrieve.successor
- The explicit successor to use for sucessor hiearchy
search if the entity does not have the property defined.
RemoteException
Object getPropertyNoDefault(String propertySet, String propertyName, ConfigurableEntity successor) throws RemoteException
propertySet
- The name of the property setpropertyName
- The name of the property to retrieve.successor
- The explicit successor to use for sucessor hiearchy
search if the entity does not have the property defined.
RemoteException
ConfigurableEntity getSuccessor(String propertySet) throws RemoteException
propertySet
- The name of the property set
RemoteException
void removeSuccessor(String propertySet) throws RemoteException
propertySet
- The name of the property set
RemoteException
void setSuccessor(String propertySet, ConfigurableEntity successor) throws RemoteException
propertySet
- The name of the property setsuccessor
- The property set-level successor used during the
search of a property.
RemoteException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |