adql.search

Class RemoveHandler

java.lang.Object

adql.search.SimpleSearchHandler

adql.search.SimpleReplaceHandler

adql.search.RemoveHandler

All Implemented Interfaces:

IReplaceHandler, ISearchHandler, java.lang.Iterable<ADQLObject>

public abstract class RemoveHandler
extends SimpleReplaceHandler

In this handler the replacement ADQLObject is always null. It may be interpreted as a removal of the matched ADQL item from its ADQL parent.

IMPORTANT: It is the responsibility of the object which calls this method to apply the removal !

Version:

11/2010

Author:

Grégory Mantelet (CDS)

Field Summary

Fields inherited from class adql.search.SimpleReplaceHandler

nbReplacement

Fields inherited from class adql.search.SimpleSearchHandler

results

Constructor Summary

Constructors

Constructor and Description
RemoveHandler()
RemoveHandler(boolean recursive)
RemoveHandler(boolean recursive, boolean onlyFirstMatch)

Method Summary

Modifier and Type	Method and Description
ADQLObject	getReplacer(ADQLObject objToReplace) Always returns null.

Methods inherited from class adql.search.SimpleReplaceHandler

addMatchAndReplace, getNbReplacement, reset, searchAndReplace

Methods inherited from class adql.search.SimpleSearchHandler

addMatch, getNbMatch, goInto, isFinished, isRecursive, iterator, match, onlyFirstMatch, search, setOnlyFirstMatch, setRecursive

Methods inherited from class java.lang.Object

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

Methods inherited from interface adql.search.ISearchHandler

getNbMatch, iterator, search

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RemoveHandler

public RemoveHandler()

RemoveHandler

public RemoveHandler(boolean recursive,
                     boolean onlyFirstMatch)

RemoveHandler

public RemoveHandler(boolean recursive)

Method Detail

getReplacer

public ADQLObject getReplacer(ADQLObject objToReplace)

Always returns null. It may be interpreted as a removal of the matched ADQL item from its ADQL parent.

IMPORTANT: It is the responsibility of the object which calls this method to apply the removal !

Specified by:

getReplacer in class SimpleReplaceHandler

Parameters:

objToReplace - The ADQL item to replace.

Returns:

The replacement ADQL item.

See Also:

SimpleReplaceHandler.getReplacer(adql.query.ADQLObject)