org.apache.stanbol.entityhub.servicesapi.query

Class TextConstraint

java.lang.Object

org.apache.stanbol.entityhub.servicesapi.query.Constraint

org.apache.stanbol.entityhub.servicesapi.query.TextConstraint

public class TextConstraint
extends Constraint

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextConstraint.PatternType

Nested classes/interfaces inherited from class org.apache.stanbol.entityhub.servicesapi.query.Constraint

Constraint.ConstraintType

Constructor Summary

Constructors

Constructor and Description
TextConstraint(List<String> text, boolean caseSensitive, String... languages)
TextConstraint(List<String> text, String... languages) Creates a TextConstraint for multiple texts and languages.
TextConstraint(List<String> text, TextConstraint.PatternType wildcardType, boolean caseSensitive, String... languages)
TextConstraint(String text, boolean caseSensitive, String... languages)
TextConstraint(String text, String... languages) Creates a TextConstraint for a text and languages.
TextConstraint(String text, TextConstraint.PatternType wildcardType, boolean caseSensitive, String... languages)

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getLanguages() The set of languages for this query.
TextConstraint.PatternType	getPatternType() The pattern type to be used for this query.
String	getText() Deprecated.
List<String>	getTexts() Getter for the text constraints.
boolean	isCaseSensitive() If the query is case sensitive
Boolean	isProximityRanking() Getter for the Term Proximity state.
void	setProximityRanking(boolean state) Setter for the proximity ranking state.
String	toString()

Methods inherited from class org.apache.stanbol.entityhub.servicesapi.query.Constraint

getBoost, getType, setBoost

Methods inherited from class java.lang.Object

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

Constructor Detail

TextConstraint

public TextConstraint(List<String> text,
              String... languages)

Creates a TextConstraint for multiple texts and languages. Parsed texts are connected using OR and may appear in any of the parsed languages.

Parameters:

text - the texts or null to search for any text in active languages

languages - the set of active languages

TextConstraint

public TextConstraint(String text,
              String... languages)

Creates a TextConstraint for a text and languages.

Parameters:

text - the text or null to search for any text in active languages

languages - the set of active languages.

TextConstraint

public TextConstraint(List<String> text,
              boolean caseSensitive,
              String... languages)

TextConstraint

public TextConstraint(String text,
              boolean caseSensitive,
              String... languages)

TextConstraint

public TextConstraint(String text,
              TextConstraint.PatternType wildcardType,
              boolean caseSensitive,
              String... languages)

TextConstraint

public TextConstraint(List<String> text,
              TextConstraint.PatternType wildcardType,
              boolean caseSensitive,
              String... languages)

Method Detail

getPatternType

public final TextConstraint.PatternType getPatternType()

The pattern type to be used for this query.

Returns:

the wildcardType

getLanguages

public final Set<String> getLanguages()

The set of languages for this query.

Returns:

the languages

isCaseSensitive

public final boolean isCaseSensitive()

If the query is case sensitive

Returns:

the caseSensitive state

getTexts

public final List<String> getTexts()

Getter for the text constraints. Multiple constraints need to be connected with OR. For AND simple post all required words in a single String.

Returns:

the text constraints

getText

@Deprecated
public final String getText()

Deprecated.

Getter for the first text constraint. If multiple constrains are set only the first one will be returned.

Returns:

the fist text constraint (of possible multiple text constraints)

isProximityRanking

public Boolean isProximityRanking()

Getter for the Term Proximity state. If enabled the proximity of the parsed terms should be used to rank search results.

Returns:

the termProximity or null if not specified

setProximityRanking

public void setProximityRanking(boolean state)

Setter for the proximity ranking state. If enabled the proximity of the parsed terms should be used to rank search results.

Parameters:

state - the proximity ranking state to set

toString

public String toString()

Overrides:

toString in class Constraint