All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.Lexical.Metaphrase.SearchSpec

java.lang.Object
    |
    +----COM.Lexical.Metaphrase.SearchSpec

public final class SearchSpec

extends java.lang.Object

implements java.lang.Cloneable

Every get<Property>() method which returns a primitive type should declare that it throws UndefinedException, to allow the property to be made optional or obsolete in a future version(s) without breaking backward-compatibility. (Get methods which return a reference type can simply return null.)

Version:

Authority1.1, 11 Apr 2000

See Also:

matches(java.lang.String, COM.Lexical.Metaphrase.SearchSpec)

SearchSpec()

Constructor for a SearchSpec with the default properties.

clone()

Return a copy of this SearchSpec.

getByScore()

Get the current setting of byScore.

getConservativeMatch()

Get the current setting of conservativeMatch.

getGroupLimit()

Get the current groupLimit.

getGroupMatches()

Get the current value of groupMatches.

getLimit()

Get the limit on the number of Match'es to return.

getMultiplexEnabled()

Get the current setting of multiplexBuffer.

getSemanticClass()

Get the current semanticClass restriction.

getShortSearch()

Get the current setting of shortSearch.

getSource()

Get the current setting of source.

getSpellCheck()

Get the current setting of spellCheck.

getTermCompletion()

Get the current value of termCompletion.

setByScore(boolean)

Specify if matches should be returned in order of score, rather than the default chunkFlags-based order.

setConservativeMatch(boolean)

Specify a very conservative (but still norm-based) match.

setGroupLimit(int)

Specify the limit for the number matches to be returned within any GroupMatch.

setGroupMatches(boolean)

Specify that "equal" matches should be returned as a MatchSet.

setLimit(int)

Set the limit on the number of Match'es to return.

setMultiplexEnabled(boolean)

Specify whether to use a MultiplexBuffer for the returned matches.

setSemanticClass(SemanticClass)

Restrict matches to concepts with the given SemanticClass.

setShortSearch(boolean)

Specify if term completion should "short-circuit".

setSource(Source)

Specify SourceMatches for source.

setSpellCheck(boolean)

Specify if spell correction should be enabled.

setTermCompletion(boolean)

Specify whether to do term completion.

toString()

Return a String describing the current settings.

public SearchSpec()

          Constructor for a SearchSpec with the default properties.

public void setLimit(int limit)

          Set the limit on the number of Match'es to return.

public int getLimit() throws UndefinedException

          Get the limit on the number of Match'es to return.

Throws:

UndefinedException - if limit is undefined.

public void setShortSearch(boolean shortSearch)

          Specify if term completion should "short-circuit".

public boolean getShortSearch() throws UndefinedException

          Get the current setting of shortSearch.

Throws:

UndefinedException - if shortSearch is undefined.

public void setByScore(boolean byScore)

          Specify if matches should be returned in order of score, rather than the default chunkFlags-based order.

public boolean getByScore() throws UndefinedException

          Get the current setting of byScore.

Throws:

UndefinedException - if byScore is undefined.

public void setSpellCheck(boolean spellCheck)

          Specify if spell correction should be enabled.

public boolean getSpellCheck() throws UndefinedException

          Get the current setting of spellCheck.

Throws:

UndefinedException - if spellCheck is undefined.

public void setConservativeMatch(boolean conservativeMatch)

          Specify a very conservative (but still norm-based) match. This disables both term completion and substring matching.

public boolean getConservativeMatch() throws UndefinedException

          Get the current setting of conservativeMatch.

Throws:

UndefinedException - if conservativeMatch is undefined.

public void setSource(Source source)

          Specify SourceMatches for source. Set to null to restore the default behavior (matching to concepts).

public Source getSource()

          Get the current setting of source.

public void setSemanticClass(SemanticClass sClass)

          Restrict matches to concepts with the given SemanticClass.

See Also:

SemanticClassifier

public SemanticClass getSemanticClass()

          Get the current semanticClass restriction.

public void setGroupMatches(boolean b)

          Specify that "equal" matches should be returned as a MatchSet. Matches are "equal" iff they have the same score and chunkFlags.

public boolean getGroupMatches() throws UndefinedException

          Get the current value of groupMatches.

Throws:

UndefinedException - if groupMatches is undefined.

public void setGroupLimit(int groupLimit)

          Specify the limit for the number matches to be returned within any GroupMatch.

public int getGroupLimit() throws UndefinedException

          Get the current groupLimit.

Throws:

UndefinedException - if groupLimit is undefined.

public void setTermCompletion(boolean b)

          Specify whether to do term completion.

public boolean getTermCompletion() throws UndefinedException

          Get the current value of termCompletion.

Throws:

UndefinedException - if termCompletion is undefined.

public void setMultiplexEnabled(boolean b)

          Specify whether to use a MultiplexBuffer for the returned matches. Only used for backward compatibility testing.

public boolean getMultiplexEnabled() throws UndefinedException

          Get the current setting of multiplexBuffer.

Throws:

UndefinedException - if multiplexBuffer is undefined.

public java.lang.Object clone() throws java.lang.CloneNotSupportedException

          Return a copy of this SearchSpec.

public java.lang.String toString()

          Return a String describing the current settings.

Overrides:

toString in class java.lang.Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index