Package adql.search

## Interface ISearchHandler

- All Superinterfaces:
    `java.lang.Iterable<ADQLObject>`
  All Known Subinterfaces:
    `IReplaceHandler`
  All Known Implementing Classes:
    `RemoveHandler`, `SearchColumnHandler`, `SimpleReplaceHandler`, `SimpleSearchHandler`

      public interface ISearchHandler
      extends java.lang.Iterable<ADQLObject>

  Defines an interface for any kind of search handler.

  A search handler is supposed to search ADQL objects matching a given condition. Then, it lets iterate on all matched items.

  A simple implementation of this interface already exists: `SimpleSearchHandler`.

  Version:
    06/2011
  Author:
    Grégory Mantelet (CDS)
  See Also:
    `IReplaceHandler`, `SimpleSearchHandler`

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `int` | `getNbMatch()` | Indicates how many ADQL objects have matched.
    `java.util.Iterator<ADQLObject>` | `iterator()` | Lets to iterate on the list of all the matched ADQL objects.
    `void` | `search​(ADQLObject startObj)` | Searches all matching ADQL objects from the given ADQL object (included).

    - ### Methods inherited from interface java.lang.Iterable

      `forEach, spliterator`

- - ### Method Detail

    - #### search

          void search​(ADQLObject startObj)

      Searches all matching ADQL objects from the given ADQL object (included).
      Parameters:
        `startObj` - The ADQL object from which the search must start.

    - #### iterator

          java.util.Iterator<ADQLObject> iterator()

      Lets to iterate on the list of all the matched ADQL objects.
      Specified by:
        `iterator` in interface `java.lang.Iterable<ADQLObject>`
      See Also:
        `Iterable.iterator()`

    - #### getNbMatch

          int getNbMatch()

      Indicates how many ADQL objects have matched.
      Returns:
        The number of all the matched ADQL objects.