com.attivio.sdk.search.fields

Class Teaser

java.lang.Object

com.attivio.sdk.search.fields.FieldExpression

com.attivio.sdk.search.fields.UnaryFieldExpression

com.attivio.sdk.search.fields.Teaser

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ScopeTeaser

public class Teaser
extends UnaryFieldExpression

Computes a dynamic teaser.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.attivio.sdk.search.fields.FieldExpression

FieldExpression.StringMode

Field Summary

Fields inherited from class com.attivio.sdk.search.fields.UnaryFieldExpression

expression

Fields inherited from class com.attivio.sdk.search.fields.FieldExpression

alias, EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
Teaser(FieldExpression expression, String alias)
Teaser(String fieldName)
Teaser(String fieldName, String alias)

Method Summary

Modifier and Type	Method and Description
Teaser	clone()
String	getFallbackField() Get the fallback field.
String	getFragmentScope() Get the name of the scope to use for fragmenting.
Integer	getFragmentSize() Get the size of generated fragments.
HighlightMode	getHighlightMode() Get the mode for annotating scopes.
String	getHighlightScope() Get the scope name to annotate phrase matches with.
String	getMatchScope() Get the scope name to annotate atomic matches with.
Integer	getNumFragments() Get the number of framents to generate (if fragmenting).
Query	getQuery() Get the query to use for highlighting.
Query	getQuery(Query defaultQuery) Get the query to use for highlighting.
String	getSeparator() Get the markup to insert between generated fragments.
String	getTokenizer() Get the name of the tokenizer to use for highlighting.
SchemaField.Type	getType(Schema schema) Resolve the type for this expression.
String[]	getWhitelist() Get the fields to extract query terms from.
int	hashCode()
boolean	isConstant() Returns true if this field expression evaluates to a constant value.
Boolean	isFragment() Get if the teaser should be fragmented.
Boolean	isMergeFragments() Get if fragments should be merged.
protected boolean	parametersEqual(FieldExpression other) Returns true if other's parameters are the same as this.
void	rewrite(QueryHandler handler, boolean recursive) Rewrite any query objects in this FieldExpression using handler.
void	setFallbackField(String field) Set the fallback field (to use if highlighting yields no text).
void	setFragment(Boolean value) Set if the teaser should be fragmented.
void	setFragmentScope(String value) Set the name of the scope to use for fragmenting.
void	setFragmentSize(Integer value) Set the size of generated fragments.
void	setHighlightMode(HighlightMode value) Set the mode for annotating scopes.
void	setHighlightScope(String value) Set the scope name to annotate phrase matches with.
void	setMatchScope(String value) Set the scope name to annotate atomic matches with.
void	setMergeFragments(Boolean value) Set if fragments should be merged.
void	setNumFragments(Integer value) Set the number of framents to generate (if fragmenting).
void	setQuery(Query value) Set the query to use for highlighting
void	setSeparator(String value) Set the markup to insert between generated fragments.
void	setTokenizer(String tokenizer) Set the tokenizer to use for highlighting.
void	setWhitelist(Collection<String> whitelist) Set the fields to extract query terms from.
void	setWhitelist(String... whitelist) Set the fields to extract query terms from.
protected void	toString(StringBuilder buffer, FieldExpression.StringMode mode) Writes the string representation of this field expression to buffer.

Methods inherited from class com.attivio.sdk.search.fields.UnaryFieldExpression

clone, equalsIgnoreAlias, getExpression, getFieldName, hasChildren, rewriteChildren, setExpression

Methods inherited from class com.attivio.sdk.search.fields.FieldExpression

as, containsAlias, copyOf, equals, equalsIgnoreAlias, getAlias, getDefaultAlias, handleFieldExpression, isConstant, quote, rewrite, setAlias, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Teaser

public Teaser(String fieldName)

Teaser

public Teaser(String fieldName,
              String alias)

Teaser

public Teaser(FieldExpression expression,
              String alias)

Method Detail

isConstant

public boolean isConstant()

Returns true if this field expression evaluates to a constant value.

Overrides:

isConstant in class UnaryFieldExpression

getType

public SchemaField.Type getType(Schema schema)

Resolve the type for this expression.

Specified by:

getType in class FieldExpression

getQuery

public Query getQuery()

Get the query to use for highlighting.

If null, the QueryRequest's highlight query will be used.

getQuery

public Query getQuery(Query defaultQuery)

Get the query to use for highlighting.

Returns defaultQuery if highlighting query is not set.

setQuery

public void setQuery(Query value)

Set the query to use for highlighting

If null, the QueryRequest's highlight query will be used.

setTokenizer

public void setTokenizer(String tokenizer)

Set the tokenizer to use for highlighting.

getTokenizer

public String getTokenizer()

Get the name of the tokenizer to use for highlighting.

getHighlightScope

public String getHighlightScope()

Get the scope name to annotate phrase matches with.

setHighlightScope

public void setHighlightScope(String value)

Set the scope name to annotate phrase matches with.

getMatchScope

public String getMatchScope()

Get the scope name to annotate atomic matches with.

setMatchScope

public void setMatchScope(String value)

Set the scope name to annotate atomic matches with.

getHighlightMode

public HighlightMode getHighlightMode()

Get the mode for annotating scopes.

setHighlightMode

public void setHighlightMode(HighlightMode value)

Set the mode for annotating scopes.

setFallbackField

public void setFallbackField(String field)

Set the fallback field (to use if highlighting yields no text).

getFallbackField

public String getFallbackField()

Get the fallback field.

setFragment

public void setFragment(Boolean value)

Set if the teaser should be fragmented.

isFragment

public Boolean isFragment()

Get if the teaser should be fragmented.

setMergeFragments

public void setMergeFragments(Boolean value)

Set if fragments should be merged.

isMergeFragments

public Boolean isMergeFragments()

Get if fragments should be merged.

setNumFragments

public void setNumFragments(Integer value)

Set the number of framents to generate (if fragmenting).

getNumFragments

public Integer getNumFragments()

Get the number of framents to generate (if fragmenting).

setFragmentSize

public void setFragmentSize(Integer value)

Set the size of generated fragments.

getFragmentSize

public Integer getFragmentSize()

Get the size of generated fragments.

getFragmentScope

public String getFragmentScope()

Get the name of the scope to use for fragmenting.

setFragmentScope

public void setFragmentScope(String value)

Set the name of the scope to use for fragmenting.

setSeparator

public void setSeparator(String value)

Set the markup to insert between generated fragments.

getSeparator

public String getSeparator()

Get the markup to insert between generated fragments.

getWhitelist

public String[] getWhitelist()

Get the fields to extract query terms from.

setWhitelist

public void setWhitelist(String... whitelist)

Set the fields to extract query terms from.

setWhitelist

public void setWhitelist(Collection<String> whitelist)

Set the fields to extract query terms from.

rewrite

public void rewrite(QueryHandler handler,
                    boolean recursive)

Rewrite any query objects in this FieldExpression using handler.

Overrides:

rewrite in class UnaryFieldExpression

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryFieldExpression

parametersEqual

protected boolean parametersEqual(FieldExpression other)

Returns true if other's parameters are the same as this.

Specified by:

parametersEqual in class UnaryFieldExpression

toString

protected void toString(StringBuilder buffer,
                        FieldExpression.StringMode mode)

Writes the string representation of this field expression to buffer.

NOTE: the alias will not be written to buffer by this function.

Specified by:

toString in class FieldExpression

clone

public Teaser clone()

Overrides:

clone in class UnaryFieldExpression