public abstract class Filter
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static int |
CAN_FAIL
Set if the Filter can exit with a false result
|
static int |
CAN_SUCCEED
Set if the Filter can exit with a true result
|
CircuitImpl |
circuit |
protected java.util.Set<com.vordel.common.util.PropDef> |
consProps |
java.lang.ClassLoader |
contextLoader |
static java.util.Set<com.vordel.common.util.PropDef> |
EMPTY_PROP_DEF_SET |
static java.util.Set<java.lang.String> |
EMPTY_STRING_SET |
protected java.util.Set<com.vordel.common.util.PropDef> |
genProps |
protected java.lang.String |
name |
protected java.util.Set<com.vordel.common.util.PropDef> |
reqProps |
Constructor and Description |
---|
Filter() |
Modifier and Type | Method and Description |
---|---|
void |
addPropDefs(java.util.Set<com.vordel.common.util.PropDef> propDefs,
java.util.Collection<java.lang.String> props) |
protected void |
configure(ConfigContext context,
Entity entity)
Called to initially configure a filter from the entity store.
|
ESPK |
getCircuitPK() |
abstract java.lang.Class<? extends FilterContainerImpl> |
getConfigPanelClass()
Get the Class which must be instantiated to configure the Filter.
|
java.util.Set<com.vordel.common.util.PropDef> |
getConsProps() |
Entity |
getEntity()
Get the underlying Entity which persists the configuration for this
Filter
|
FilterContainerImpl |
getFailureNode()
Get the next node to visit, should this Filter fail upon invocation
|
protected ESPK |
getFailureNodePK()
Get the ESPK of the Filter to visit if this Filter fails
|
java.util.Set<com.vordel.common.util.PropDef> |
getGenProps() |
abstract java.lang.Class<? extends MessageProcessor> |
getMessageProcessorClass()
Get the Class which must be instantiated to process this Filter to implement a MessageProcessor
|
java.lang.String |
getName()
Get the name of the Filter
|
int |
getPossibleOutcomes()
Get the bitmask for the possible outcomes to this Filter's evaluation.
|
java.util.Set<com.vordel.common.util.PropDef> |
getReqProps() |
FilterContainerImpl |
getSuccessNode()
Get the next node to visit, should this Filter succeed upon invocation
|
protected ESPK |
getSuccessNodePK()
Get the ESPK of the Filter to visit if this Filter succeeds
|
void |
reconfigure(ConfigContext ctx,
Entity entity) |
void |
setCircuitPK(ESPK circuitPK) |
protected void |
setDefaultPropertyDefs() |
void |
setEntity(Entity entity) |
protected void |
setFailureNode(FilterContainerImpl fc) |
void |
setName(java.lang.String name) |
void |
setShouldAbortProcessingOnLogError(boolean _abort) |
protected void |
setSuccessNode(FilterContainerImpl fc) |
boolean |
shouldAbortProcessingOnLogError() |
public static java.util.Set<com.vordel.common.util.PropDef> EMPTY_PROP_DEF_SET
public static java.util.Set<java.lang.String> EMPTY_STRING_SET
public static final int CAN_SUCCEED
public static final int CAN_FAIL
public CircuitImpl circuit
protected java.util.Set<com.vordel.common.util.PropDef> reqProps
protected java.util.Set<com.vordel.common.util.PropDef> genProps
protected java.util.Set<com.vordel.common.util.PropDef> consProps
protected java.lang.String name
public java.lang.ClassLoader contextLoader
public java.util.Set<com.vordel.common.util.PropDef> getReqProps()
public java.util.Set<com.vordel.common.util.PropDef> getGenProps()
public java.util.Set<com.vordel.common.util.PropDef> getConsProps()
public void addPropDefs(java.util.Set<com.vordel.common.util.PropDef> propDefs, java.util.Collection<java.lang.String> props)
public int getPossibleOutcomes()
public abstract java.lang.Class<? extends MessageProcessor> getMessageProcessorClass() throws java.lang.ClassNotFoundException
java.lang.ClassNotFoundException
- If the class is unavailablepublic abstract java.lang.Class<? extends FilterContainerImpl> getConfigPanelClass() throws java.lang.ClassNotFoundException
java.lang.ClassNotFoundException
- If the class is unavailablepublic FilterContainerImpl getSuccessNode()
public FilterContainerImpl getFailureNode()
public Entity getEntity()
public java.lang.String getName()
public void setName(java.lang.String name)
protected ESPK getSuccessNodePK()
public boolean shouldAbortProcessingOnLogError()
public void setShouldAbortProcessingOnLogError(boolean _abort)
protected ESPK getFailureNodePK()
protected void setSuccessNode(FilterContainerImpl fc)
protected void setFailureNode(FilterContainerImpl fc)
protected void configure(ConfigContext context, Entity entity) throws EntityStoreException
context
- The configuration contextentity
- The entity pertaining to this Filter instanceEntityStoreException
- If there's a problem during configurationpublic void reconfigure(ConfigContext ctx, Entity entity) throws EntityStoreException
EntityStoreException
public void setEntity(Entity entity)
public ESPK getCircuitPK()
public void setCircuitPK(ESPK circuitPK)
protected void setDefaultPropertyDefs()
This documentation and all its contents and graphics, copyright © 1999 - 2011 Vordel