org.icepdf.core.search
Class SearchTerm

java.lang.Object
  org.icepdf.core.search.SearchTerm

public class SearchTerm
extends java.lang.Object

Text searchs are used by the search controller to search for text in a document. A search can have one or more search terms which are all searched for in a given search.

Since:

4.0

Constructor Summary

SearchTerm(java.lang.String term, java.util.ArrayList<java.lang.String> terms, boolean caseSensitive, boolean wholeWord)
Creates a new search term.

Method Summary

boolean	equals(java.lang.Object object)
java.lang.String	getTerm() Get origional search term.
java.util.ArrayList<java.lang.String>	getTerms() Gets individual strings that make up the search term,
boolean	isCaseSensitive() Specifies if the search term should be treated as case sensitive.
boolean	isWholeWord() Specifies if the search term should be treated as whole word hits only.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTerm

public SearchTerm(java.lang.String term,
                  java.util.ArrayList<java.lang.String> terms,
                  boolean caseSensitive,
                  boolean wholeWord)

Creates a new search term.

Parameters:

term - full string represented by terms.

terms - terms that make ups serach

caseSensitive - true to specify a case sensitive search

wholeWord - true to specify a whole word only search.

Method Detail

getTerms

public java.util.ArrayList<java.lang.String> getTerms()

Gets individual strings that make up the search term,

Returns:

list of strings that contain searchable words.

getTerm

public java.lang.String getTerm()

Get origional search term.

Returns:

term, word or phrase used to search.

isCaseSensitive

public boolean isCaseSensitive()

Specifies if the search term should be treated as case sensitive.

Returns:

true if cases senstive search, otherwise false.

isWholeWord

public boolean isWholeWord()

Specifies if the search term should be treated as whole word hits only.

Returns:

true if whole word search, otherwise false.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object