Package de.espirit.firstspirit.access.search

Class Match

java.lang.Object
de.espirit.firstspirit.access.search.Match
All Implemented Interfaces:
Serializable
public class Match extends Object implements Serializable
Container for describing a match of a search.
Since:
4.0.17
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Match(de.espirit.firstspirit.access.search.PatternClause clause, int begin, int end)
    Constructor based on a single clause and providing textual markers.
    Match(Set<de.espirit.firstspirit.access.search.PatternClause> clauses)
    Constructor based on a set of clauses.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getBegin()
    Provides the starting position of the match within the text it bases upon.
    Set<de.espirit.firstspirit.access.search.PatternClause>
    getClauses()
    Provides the clauses, which were matched.
    int
    getEnd()
    Provides the ending position of the match within the text it bases upon.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Match

      public Match(de.espirit.firstspirit.access.search.PatternClause clause, int begin, int end)
      Constructor based on a single clause and providing textual markers.
      Parameters:
      clause - The clause matched.
      begin - The starting position within the text.
      end - The ending position within the text.
      Since:
      4.0.17

    • Match

      public Match(Set<de.espirit.firstspirit.access.search.PatternClause> clauses)
      Constructor based on a set of clauses.
      Parameters:
      clauses - The clauses matched.
      Since:
      4.0.17

  • Method Details

    • getClauses

      public Set<de.espirit.firstspirit.access.search.PatternClause> getClauses()
      Provides the clauses, which were matched.
      Returns:
      A set of clauses.
      Since:
      4.0.17

    • getBegin

      public int getBegin()
      Provides the starting position of the match within the text it bases upon.
      Returns:
      The starting position or -1, if none given.
      Since:
      4.0.17

    • getEnd

      public int getEnd()
      Provides the ending position of the match within the text it bases upon.
      Returns:
      The ending position or -1, if none given.
      Since:
      4.0.17