wt.configuration
Class RemoveConfigurationVisitor

java.lang.Object
  extended bywt.visitor.VisitorAdapter
      extended bywt.configuration.RemoveConfigurationVisitor
All Implemented Interfaces:
ConfigSpec, Externalizable, Serializable, SQLFunctionConfigSpec, Visitor

public class RemoveConfigurationVisitor
extends VisitorAdapter
implements SQLFunctionConfigSpec, Serializable



Supported API: true

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private  BaselineConfigurationVersion configuration
           
private  BaselineConfigurationConfigSpec configurationSpec
           
private  ConfigurationDelegate delegate
           
static long EXTERNALIZATION_VERSION_UID
           
private  Hashtable iterationMemberHash
           
private  ConfigurationMemberConfigSpec memberSpec
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  StandardConfigurationService service
           
 
Constructor Summary
RemoveConfigurationVisitor(BaselineConfigurationVersion configuration, StandardConfigurationService service, ConfigurationDelegate delegate)
          

Supported API: false
 
Method Summary
 QuerySpec appendSearchCriteria(QuerySpec querySpec)
          Appends to the supplied QuerySpec additional search criteria to reduce the resulting iterations to only those that will be considered by this ConfigSpec.
 StatementParameter[] getAdditionalParameters()
          

Supported API: false
 String getSQLFunctionName()
          

Supported API: false
 QueryResult process(QueryResult results)
          Process the QueryResult of iterations, returning only those that "match" according to the algorithm.
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(RemoveConfigurationVisitor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
protected  void reset()
           
 boolean useFunction()
          

Supported API: false
 boolean visit(Persistable fromNode, Link link, Persistable toNode, int level, boolean previouslyVisited)
          Visits a node and adds it to a Baseline.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 
Methods inherited from class wt.visitor.VisitorAdapter
visitLevel, visitLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

configurationSpec

private BaselineConfigurationConfigSpec configurationSpec

iterationMemberHash

private Hashtable iterationMemberHash

delegate

private ConfigurationDelegate delegate

configuration

private BaselineConfigurationVersion configuration

service

private StandardConfigurationService service

memberSpec

private ConfigurationMemberConfigSpec memberSpec

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

RemoveConfigurationVisitor

public RemoveConfigurationVisitor(BaselineConfigurationVersion configuration,
                                  StandardConfigurationService service,
                                  ConfigurationDelegate delegate)
                           throws WTPropertyVetoException


Supported API: false

Parameters:
configuration -
service -
delegate -
Throws:
WTPropertyVetoException
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(RemoveConfigurationVisitor thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

visit

public boolean visit(Persistable fromNode,
                     Link link,
                     Persistable toNode,
                     int level,
                     boolean previouslyVisited)
              throws WTException
Visits a node and adds it to a Baseline. If this node has been previously visited, then false is returned.

Supported API: true

Specified by:
visit in interface Visitor
Overrides:
visit in class VisitorAdapter
Parameters:
fromNode -
link -
toNode -
level -
previouslyVisited -
Returns:
boolean
Throws:
WTException

useFunction

public boolean useFunction()


Supported API: false

Specified by:
useFunction in interface SQLFunctionConfigSpec
Returns:
boolean

getSQLFunctionName

public String getSQLFunctionName()


Supported API: false

Specified by:
getSQLFunctionName in interface SQLFunctionConfigSpec
Returns:
String

getAdditionalParameters

public StatementParameter[] getAdditionalParameters()


Supported API: false

Specified by:
getAdditionalParameters in interface SQLFunctionConfigSpec
Returns:
StatementParameter[]

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException
Appends to the supplied QuerySpec additional search criteria to reduce the resulting iterations to only those that will be considered by this ConfigSpec. Appending additional classes to the QuerySpec is allowed (for join purposes), but those that are marked as selectable will be trimmed by "filteredIterationsOf" prior to it calling the "process" API.

The QueryResult returned should be a copy of the passed in one (taking advantage of side-effects is not encouraged).



Supported API: true

Specified by:
appendSearchCriteria in interface ConfigSpec
Parameters:
querySpec - A QuerySpec with a target class that is Iterated.
Returns:
QuerySpec
Throws:
WTException
QueryException
See Also:
QuerySpec, SearchCondition

process

public QueryResult process(QueryResult results)
                    throws WTException
Process the QueryResult of iterations, returning only those that "match" according to the algorithm.

The QueryResult returned should be a copy of the passed-in QueryResult (side-effects should be avoided).



Supported API: true

Specified by:
process in interface ConfigSpec
Parameters:
results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria. Note that after enumerating through the elements of this QueryResult, it should be reset.
Returns:
QueryResult
Throws:
WTException
See Also:
QueryResult, Iterated

reset

protected void reset()