com.metamatrix.query.sql.visitor
Class PredicateCollectorVisitor

java.lang.Object
  com.metamatrix.query.sql.LanguageVisitor
      com.metamatrix.query.sql.visitor.PredicateCollectorVisitor

public class PredicateCollectorVisitor
extends LanguageVisitor

Walk a tree of language objects and collect any predicate criteria that are found. A predicate criteria is of the following types:

• CompareCriteria CompareCriteria
• MatchCriteria MatchCriteria
• SetCriteria SetCriteria
• SubquerySetCriteria SubquerySetCriteria
• IsNullCriteria IsNullCriteria

Constructor Summary

PredicateCollectorVisitor()
Construct a new visitor with the default collection type, which is a ArrayList.

Method Summary

java.util.Collection	getPredicates() Get a collection of predicates discovered while visiting.
static java.util.Collection	getPredicates(LanguageObject obj) Helper to quickly get the predicates from obj
void	visit(BetweenCriteria obj) Visit a language object and collect criteria.
void	visit(CompareCriteria obj) Visit a language object and collect criteria.
void	visit(DependentSetCriteria obj) Visit a language object and collect criteria.
void	visit(ExistsCriteria obj)
void	visit(IsNullCriteria obj) Visit a language object and collect criteria.
void	visit(MatchCriteria obj) Visit a language object and collect criteria.
void	visit(SetCriteria obj) Visit a language object and collect criteria.
void	visit(SubqueryCompareCriteria obj)
void	visit(SubquerySetCriteria obj) Visit a language object and collect criteria.

Methods inherited from class com.metamatrix.query.sql.LanguageVisitor

setAbort, shouldAbort, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PredicateCollectorVisitor

public PredicateCollectorVisitor()

Construct a new visitor with the default collection type, which is a ArrayList.

Method Detail

visit

public void visit(BetweenCriteria obj)

Visit a language object and collect criteria. This method should NOT be called directly.

Overrides:

visit in class LanguageVisitor

Parameters:

obj - Language object

visit

public void visit(CompareCriteria obj)

Visit a language object and collect criteria. This method should NOT be called directly.

Overrides:

visit in class LanguageVisitor

Parameters:

obj - Language object

visit

public void visit(IsNullCriteria obj)

Visit a language object and collect criteria. This method should NOT be called directly.

Overrides:

visit in class LanguageVisitor

Parameters:

obj - Language object

visit

public void visit(MatchCriteria obj)

Visit a language object and collect criteria. This method should NOT be called directly.

Overrides:

visit in class LanguageVisitor

Parameters:

obj - Language object

visit

public void visit(SetCriteria obj)

Visit a language object and collect criteria. This method should NOT be called directly.

Overrides:

visit in class LanguageVisitor

Parameters:

obj - Language object

visit

public void visit(DependentSetCriteria obj)

Visit a language object and collect criteria. This method should NOT be called directly.

Overrides:

visit in class LanguageVisitor

Parameters:

obj - Language object

visit

public void visit(ExistsCriteria obj)

Overrides:

visit in class LanguageVisitor

See Also:

LanguageVisitor.visit(com.metamatrix.query.sql.lang.ExistsCriteria)

visit

public void visit(SubqueryCompareCriteria obj)

Overrides:

visit in class LanguageVisitor

See Also:

LanguageVisitor.visit(com.metamatrix.query.sql.lang.SubqueryCompareCriteria)

visit

public void visit(SubquerySetCriteria obj)

Visit a language object and collect criteria. This method should NOT be called directly.

Overrides:

visit in class LanguageVisitor

Parameters:

obj - Language object

getPredicates

public java.util.Collection getPredicates()

Get a collection of predicates discovered while visiting.

Returns:

Collection of PredicateCriteria subclasses.

getPredicates

public static final java.util.Collection getPredicates(LanguageObject obj)

Helper to quickly get the predicates from obj

Parameters:

obj - Language object