com.exalead.search.query.node

Class AlphanumValue

java.lang.Object

com.exalead.search.query.node.Node

com.exalead.search.query.node.IndexValue

com.exalead.search.query.node.AlphanumValue

All Implemented Interfaces:

java.lang.Cloneable

public class AlphanumValue
extends IndexValue
implements java.lang.Cloneable

Alphanumerical value to query in the index or to highlight. A value targets an index field and is indexed under a certain indexKind.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	context
java.lang.String	cpath
java.lang.String	formName If this alphanum value comes from the expansion of a Form, its name
int	indexGroupId
int	indexKind
int	indexSeqId
java.util.List<java.lang.String>	tokens If the alphanum value comes from the expansion of a Form, the list of original Tokens (E.g.
java.lang.String	value

Fields inherited from class com.exalead.search.query.node.IndexValue

field

Fields inherited from class com.exalead.search.query.node.Node

indexOptions

Constructor Summary

Constructors

Constructor and Description
AlphanumValue()
AlphanumValue(AlphanumValue other) Copy constructor
AlphanumValue(java.lang.String value) Create a new Alphanumerical node without field set
AlphanumValue(java.lang.String value, int indexKind)
AlphanumValue(java.lang.String field, java.lang.String value)
AlphanumValue(java.lang.String field, java.lang.String value, IndexOptions indexOptions)
AlphanumValue(java.lang.String field, java.lang.String value, int indexKind, IndexOptions indexOptions)
AlphanumValue(java.lang.String field, java.lang.String value, java.lang.String cpath, IndexOptions indexOptions) Create a new Alphanumerical node with field set.

Method Summary

Modifier and Type	Method and Description
Node	accept(NodeVisitor visitor)
Node	cloneNode()
java.lang.String	getContext() Get the index context targeted by this node
java.lang.String	getFormName()
int	getIndexGroupId()
int	getIndexKind() Get the index kind for this node.
int	getIndexSeqId()
boolean	getMayExpand()
java.lang.String	getPath() Get the cpath of this node
boolean	getPatternSearch()
int	getPatternSearchMaxNbLists()
java.lang.String	getSourceName()
TokenizedNode.Token.StopWordLevel	getStopWordLevel()
java.lang.String	getValue() Get the search value of this node
double	getWeight()
boolean	isTokenized()
void	setContext(java.lang.String context) Set the index context targeted by this node
void	setCorpusFrequency(long freq) Set the frequency of the value in the corpus (i.e.
AlphanumValue	setFormName(java.lang.String formName)
void	setIndexGroupId(int groupId)
void	setIndexKind(int indexKind) Set the index kind for this node.
void	setIndexSeqId(int seqId)
void	setMayExpand(boolean b)
void	setPath(java.lang.String cpath) Set the cpath of this node
AlphanumValue	setPatternSearch(boolean patternSearch)
AlphanumValue	setPatternSearchMaxNbLists(int patternSearchMaxNbLists)
void	setSource(ModuleConfigs.Base source)
void	setStopWordLevel(TokenizedNode.Token.StopWordLevel sw)
void	setTokenized(boolean b)
void	setValue(java.lang.String value) Set the search value of this node
void	setWeight(double value)
void	toELLQL(java.lang.StringBuilder buffer, boolean sortNAry)

Methods inherited from class com.exalead.search.query.node.IndexValue

getField, setField

Methods inherited from class com.exalead.search.query.node.Node

copyOptionsFrom, escapeStr, getHighlight, toELLQLBinary, toELLQLConstant, toELLQLNAry, toELLQLUnary, unEscapeStr

Methods inherited from class java.lang.Object

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

Field Detail

context

public java.lang.String context

value

public java.lang.String value

cpath

public java.lang.String cpath

indexKind

public int indexKind

indexSeqId

public int indexSeqId

indexGroupId

public int indexGroupId

formName

public java.lang.String formName

If this alphanum value comes from the expansion of a Form, its name

tokens

public java.util.List<java.lang.String> tokens

If the alphanum value comes from the expansion of a Form, the list of original Tokens (E.g. "DBA" comes from "database" followed by "administrator"

Constructor Detail

AlphanumValue

public AlphanumValue()

AlphanumValue

public AlphanumValue(java.lang.String value)

Create a new Alphanumerical node without field set

AlphanumValue

public AlphanumValue(java.lang.String value,
                     int indexKind)

AlphanumValue

public AlphanumValue(java.lang.String field,
                     java.lang.String value,
                     java.lang.String cpath,
                     IndexOptions indexOptions)

Create a new Alphanumerical node with field set.

AlphanumValue

public AlphanumValue(java.lang.String field,
                     java.lang.String value,
                     int indexKind,
                     IndexOptions indexOptions)

AlphanumValue

public AlphanumValue(java.lang.String field,
                     java.lang.String value,
                     IndexOptions indexOptions)

AlphanumValue

public AlphanumValue(java.lang.String field,
                     java.lang.String value)

AlphanumValue

public AlphanumValue(AlphanumValue other)

Copy constructor

Method Detail

getSourceName

public java.lang.String getSourceName()

setMayExpand

public void setMayExpand(boolean b)

getMayExpand

public boolean getMayExpand()

isTokenized

public boolean isTokenized()

setTokenized

public void setTokenized(boolean b)

cloneNode

public Node cloneNode()

Specified by:

cloneNode in class Node

setPatternSearch

public AlphanumValue setPatternSearch(boolean patternSearch)

setPatternSearchMaxNbLists

public AlphanumValue setPatternSearchMaxNbLists(int patternSearchMaxNbLists)

getPatternSearchMaxNbLists

public int getPatternSearchMaxNbLists()

getPatternSearch

public boolean getPatternSearch()

setFormName

public AlphanumValue setFormName(java.lang.String formName)

See Also:

formName

getContext

public java.lang.String getContext()

Get the index context targeted by this node

setContext

public void setContext(java.lang.String context)

Set the index context targeted by this node

getValue

public java.lang.String getValue()

Get the search value of this node

setValue

public void setValue(java.lang.String value)

Set the search value of this node

getPath

public java.lang.String getPath()

Get the cpath of this node

setPath

public void setPath(java.lang.String cpath)

Set the cpath of this node

setCorpusFrequency

public void setCorpusFrequency(long freq)

Set the frequency of the value in the corpus (i.e. the number of documents that contain the word)

getIndexKind

public int getIndexKind()

Get the index kind for this node. Please refer to the documentation for more information on index kinds

setIndexKind

public void setIndexKind(int indexKind)

Set the index kind for this node. Please refer to the documentation for more information on index kinds

getIndexSeqId

public int getIndexSeqId()

setIndexSeqId

public void setIndexSeqId(int seqId)

getIndexGroupId

public int getIndexGroupId()

setIndexGroupId

public void setIndexGroupId(int groupId)

setSource

public void setSource(ModuleConfigs.Base source)

See Also:

source

getStopWordLevel

public TokenizedNode.Token.StopWordLevel getStopWordLevel()

See Also:

#sw

setStopWordLevel

public void setStopWordLevel(TokenizedNode.Token.StopWordLevel sw)

See Also:

#sw

getFormName

public java.lang.String getFormName()

See Also:

formName

setWeight

public void setWeight(double value)

getWeight

public double getWeight()

toELLQL

public void toELLQL(java.lang.StringBuilder buffer,
                    boolean sortNAry)

Specified by:

toELLQL in class Node

accept

public Node accept(NodeVisitor visitor)
            throws QueryProcessingException

Specified by:

accept in class Node

Throws:

QueryProcessingException