com.sapportals.wcm.service.indexmanagement.retrieval.search
Interface IQueryEntry

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]

All Superinterfaces:

java.io.Serializable

public interface IQueryEntry

extends java.io.Serializable

Single entry of a complex search query.

Field Summary

static java.lang.String	OPERATOR_AND if query entry is an operator entry the value can be OPERATOR_AND, OPERATOR_OR or OPERATOR_NOT
static java.lang.String	OPERATOR_NOT if query entry is an operator entry the value can be OPERATOR_AND, OPERATOR_OR or OPERATOR_NOT
static java.lang.String	OPERATOR_OR if query entry is an operator entry the value can be OPERATOR_AND, OPERATOR_OR or OPERATOR_NOT
static byte	PROPERTY_OPERATOR_BETWEEN Property value should be between value 1 and value 2 of the query entry
static byte	PROPERTY_OPERATOR_EQUAL Property value should be equal to the value of the query entry
static byte	PROPERTY_OPERATOR_GREATER Property value should be greater than the value of the query entry
static byte	PROPERTY_OPERATOR_GREATER_OR_EQUAL Property value should be greater or equal the value of the query entry
static byte	PROPERTY_OPERATOR_LESS Property value should be less than the value of the query entry
static byte	PROPERTY_OPERATOR_LESS_OR_EQUAL Property value should be less or equal the value of the query entry
static byte	PROPERTY_OPERATOR_NOT Property value should not be equal to the value of the query entry
static byte	PROPERTY_TYPE_DATE if query entry is an attribute entry you can specifiy the property type
static byte	PROPERTY_TYPE_INTEGER if query entry is an attribute entry you can specifiy the property type
static byte	PROPERTY_TYPE_STRING if query entry is an attribute entry you can specifiy the property type
static byte	PROPERTY_TYPE_TEXT if query entry is an attribute entry you can specifiy the property type
static byte	PROPERTY_TYPE_USE_META_MODEL if query entry is an attribute entry you can specifiy the property type
static java.lang.String	ROW_TYPE_ATTRIBUTE specifies that query entry is an attribute entry
static java.lang.String	ROW_TYPE_BRACKET_CLOSE specifies that query entry is an close bracket entry
static java.lang.String	ROW_TYPE_BRACKET_OPEN specifies that query entry is an open bracket entry
static java.lang.String	ROW_TYPE_OPERATOR specifies that query entry is an operator entry
static java.lang.String	ROW_TYPE_TERM specifies that query entry is a term entry
static byte	TERM_ACTION_EXACT exact search
static byte	TERM_ACTION_FUZZY fuzzy search
static byte	TERM_ACTION_LINGUISTIC linguistic search
static byte	TERM_ACTION_NEAR_WIDTH near with search
static byte	TERM_ACTION_SOUNDEX soundex search

Method Summary

IQueryEntry	cloneEntry() Clones itself.
IPropertyName	getCMPropertyName()
float	getFuzziness()
java.lang.String	getPropertyName() Deprecated. as of NW04. Use getCMPropertyName()
byte	getPropertyOperator() The property operator defines the context of the query entry value.
byte	getPropertyType()
java.lang.String	getRowType() Returns the row type
java.util.List	getSubstitutedTerms() Returns the corrected terms
byte	getTermAction() Returns the term action
float	getTermWeight()
java.lang.String	getValue1AsString()
java.util.Date	getValue1DateValue()
int	getValue1IntValue()
java.lang.String	getValue2AsString()
java.util.Date	getValue2DateValue()
int	getValue2IntValue()
java.lang.String	getValueAsString()
java.util.Date	getValueDateValue()
int	getValueIntValue()
boolean	isTermsChanged() Returns true if the terms are changed
void	setDateValue(java.lang.String dateValue) Sets the first value on date value.
void	setDateValue(java.lang.String dateValue1, java.lang.String dateValue2) Sets the first and second value on date values.
void	setFuzziness(float fuzziness) must be used for fuzzy search. if no fuzziness is set the default fuzziness for the index is used. the default fuzziness can be set via the index administration
void	setPropertyName(IPropertyName cmPropertyName) Optional: defines in which attribute the search is to be executed if an attribute search is executed
void	setPropertyName(java.lang.String propertyName) Deprecated. as of NW04. See setPropertyName(IPropertyName)
void	setPropertyOperator(byte propertyOperator) The property operator defines the context of the query entry value.
void	setPropertyType(byte propertyType) Adds a property type.
void	setRowType(java.lang.String rowType) Sets the row type
void	setSubstitutedTerms(java.util.List substitutedTerms) Sets the corrected terms
void	setTermAction(byte termAction) Adds a term action; the term action defines how the search is executed (fuzzy, exact,...) (it must only be called when the row type is ROW_TYPE_ATTRIBUTE or ROW_TYPE_TERM)
void	setTermsChanged(boolean hasChanged) Set on true if the terms are changed
void	setTermWeight(float weight) Sets the term weight the term weight goes from 0.0 ... 1.0
void	setValue(java.util.Date dateValue) Sets the value
void	setValue(java.util.Date dateValue1, java.util.Date dateValue2) result is between value1 and value2
void	setValue(int intValue) Sets the value
void	setValue(int intValue1, int intValue2) result is between value1 and value2
void	setValue(java.lang.String stringValue) Sets the value
void	setValue(java.lang.String value1, java.lang.String value2)
boolean	specialEqual1(IQueryEntry e2)

Field Detail

TERM_ACTION_LINGUISTIC

public static final byte TERM_ACTION_LINGUISTIC

linguistic search

TERM_ACTION_FUZZY

public static final byte TERM_ACTION_FUZZY

fuzzy search

TERM_ACTION_NEAR_WIDTH

public static final byte TERM_ACTION_NEAR_WIDTH

near with search

TERM_ACTION_EXACT

public static final byte TERM_ACTION_EXACT

exact search

TERM_ACTION_SOUNDEX

public static final byte TERM_ACTION_SOUNDEX

soundex search

PROPERTY_TYPE_USE_META_MODEL

public static final byte PROPERTY_TYPE_USE_META_MODEL

if query entry is an attribute entry you can specifiy the property type

PROPERTY_TYPE_STRING

public static final byte PROPERTY_TYPE_STRING

if query entry is an attribute entry you can specifiy the property type

PROPERTY_TYPE_DATE

public static final byte PROPERTY_TYPE_DATE

if query entry is an attribute entry you can specifiy the property type

PROPERTY_TYPE_INTEGER

public static final byte PROPERTY_TYPE_INTEGER

if query entry is an attribute entry you can specifiy the property type

PROPERTY_TYPE_TEXT

public static final byte PROPERTY_TYPE_TEXT

if query entry is an attribute entry you can specifiy the property type

ROW_TYPE_TERM

public static final java.lang.String ROW_TYPE_TERM

specifies that query entry is a term entry

ROW_TYPE_ATTRIBUTE

public static final java.lang.String ROW_TYPE_ATTRIBUTE

specifies that query entry is an attribute entry

ROW_TYPE_OPERATOR

public static final java.lang.String ROW_TYPE_OPERATOR

specifies that query entry is an operator entry

ROW_TYPE_BRACKET_OPEN

public static final java.lang.String ROW_TYPE_BRACKET_OPEN

specifies that query entry is an open bracket entry

ROW_TYPE_BRACKET_CLOSE

public static final java.lang.String ROW_TYPE_BRACKET_CLOSE

specifies that query entry is an close bracket entry

OPERATOR_AND

public static final java.lang.String OPERATOR_AND

if query entry is an operator entry the value can be OPERATOR_AND, OPERATOR_OR or OPERATOR_NOT

OPERATOR_OR

public static final java.lang.String OPERATOR_OR

if query entry is an operator entry the value can be OPERATOR_AND, OPERATOR_OR or OPERATOR_NOT

OPERATOR_NOT

public static final java.lang.String OPERATOR_NOT

if query entry is an operator entry the value can be OPERATOR_AND, OPERATOR_OR or OPERATOR_NOT

PROPERTY_OPERATOR_EQUAL

public static final byte PROPERTY_OPERATOR_EQUAL

Property value should be equal to the value of the query entry

PROPERTY_OPERATOR_NOT

public static final byte PROPERTY_OPERATOR_NOT

Property value should not be equal to the value of the query entry

PROPERTY_OPERATOR_BETWEEN

public static final byte PROPERTY_OPERATOR_BETWEEN

Property value should be between value 1 and value 2 of the query entry

PROPERTY_OPERATOR_GREATER

public static final byte PROPERTY_OPERATOR_GREATER

Property value should be greater than the value of the query entry

PROPERTY_OPERATOR_LESS

public static final byte PROPERTY_OPERATOR_LESS

Property value should be less than the value of the query entry

PROPERTY_OPERATOR_GREATER_OR_EQUAL

public static final byte PROPERTY_OPERATOR_GREATER_OR_EQUAL

Property value should be greater or equal the value of the query entry

PROPERTY_OPERATOR_LESS_OR_EQUAL

public static final byte PROPERTY_OPERATOR_LESS_OR_EQUAL

Property value should be less or equal the value of the query entry

Method Detail

cloneEntry

public IQueryEntry cloneEntry()

Clones itself.

Returns:

a clone object of this query entry

setSubstitutedTerms

public void setSubstitutedTerms(java.util.List substitutedTerms)

Sets the corrected terms

Parameters:

substitutedTerms - List of Strings

getSubstitutedTerms

public java.util.List getSubstitutedTerms()

Returns the corrected terms

Returns:

List of Strings

setTermsChanged

public void setTermsChanged(boolean hasChanged)

Set on true if the terms are changed

Parameters:

hasChanged -

isTermsChanged

public boolean isTermsChanged()

Returns true if the terms are changed

Returns:

boolean

setValue

public void setValue(java.lang.String stringValue)

Sets the value

setValue

public void setValue(int intValue)

Sets the value

setValue

public void setValue(java.util.Date dateValue)

Sets the value

setDateValue

public void setDateValue(java.lang.String dateValue)
                  throws java.text.ParseException

Sets the first value on date value. The parameter has to describe a date in the following format: yyyyMMddHHmmss

Parameters:

dateValue -

setDateValue

public void setDateValue(java.lang.String dateValue1,
                         java.lang.String dateValue2)
                  throws java.text.ParseException

Sets the first and second value on date values. The parameters have to describe dates in the following format: yyyyMMddHHmmss

Parameters:

dateValue1 -

dateValue2 -

setValue

public void setValue(int intValue1,
                     int intValue2)

result is between value1 and value2

setValue

public void setValue(java.lang.String value1,
                     java.lang.String value2)

setValue

public void setValue(java.util.Date dateValue1,
                     java.util.Date dateValue2)

result is between value1 and value2

setRowType

public void setRowType(java.lang.String rowType)
                throws WcmException

Sets the row type

Parameters:

rowType - row type, see static attributes ROW_TYPE_xxx

setTermWeight

public void setTermWeight(float weight)
                   throws WcmException

Sets the term weight
the term weight goes from 0.0 ... 1.0

setTermAction

public void setTermAction(byte termAction)
                   throws WcmException

Adds a term action; the term action defines how the search is executed (fuzzy, exact,...) (it must only be called when the row type is ROW_TYPE_ATTRIBUTE or ROW_TYPE_TERM)

Parameters:

action - term action, use static attributes TERM_ACTION_xxx

setPropertyType

public void setPropertyType(byte propertyType)
                     throws WcmException

Adds a property type.
The property type defines the kind of property to search on (string, date, integer, ...).
It must only be called when the row type is ROW_TYPE_ATTRIBUTE. The default value is PROPERTY_TYPE_STRING)

Parameters:

property - type, use static attributes PROPERTY_TYPE_xxx

setPropertyOperator

public void setPropertyOperator(byte propertyOperator)

The property operator defines the context of the query entry value. It is only needed when the query entry is of row type IQueryEntry.ROW_TYPE_ATTRIBUTE. Use constants beginning with IQueryEntry.PROPERTY_OPERATOR_. Default is IQueryEntry.PROPERTY_OPERATOR_EQUAL.

Parameters:

operator - of the query entry value

setPropertyName

public void setPropertyName(java.lang.String propertyName)
                     throws WcmException

Deprecated. as of NW04. See setPropertyName(IPropertyName)

Optional: defines in which attribute the search is to be executed if an attribute search is executed

Parameters:

property - name - name of the property in that has to be searched

setPropertyName

public void setPropertyName(IPropertyName cmPropertyName)
                     throws WcmException

Optional: defines in which attribute the search is to be executed if an attribute search is executed

Parameters:

property - name - name of the property in that has to be searched

getPropertyName

public java.lang.String getPropertyName()

Deprecated. as of NW04. Use getCMPropertyName()

Returns:

the property name

getCMPropertyName

public IPropertyName getCMPropertyName()

Returns:

the IPropertyName object that has been set.

getPropertyType

public byte getPropertyType()

Returns:

the property type. For possible return values, see static attribute PROPERTY_TYPE_xxx

getPropertyOperator

public byte getPropertyOperator()

The property operator defines the context of the query entry value. It is only needed when the query entry is of row type IQueryEntry.ROW_TYPE_ATTRIBUTE. Use constants beginning with IQueryEntry.PROPERTY_OPERATOR_. Default is IQueryEntry.PROPERTY_OPERATOR_EQUAL.

Returns:

operator of the property

getTermAction

public byte getTermAction()

Returns the term action

Returns:

for possible return values, see static attribute TERM_ACTION_xxx

getTermWeight

public float getTermWeight()

Returns:

the term weight

getRowType

public java.lang.String getRowType()

Returns the row type

Returns:

for possible return values, see static attributes ROW_TYPE_xxx

getValue1AsString

public java.lang.String getValue1AsString()

Returns:

value1 in string format

getValue1DateValue

public java.util.Date getValue1DateValue()

Returns:

value1 as date

getValue1IntValue

public int getValue1IntValue()

Returns:

value1 as int

getValueAsString

public java.lang.String getValueAsString()

Returns:

value set by setValue() in string format

getValueDateValue

public java.util.Date getValueDateValue()

Returns:

date value set by setValue()

getValueIntValue

public int getValueIntValue()

Returns:

int value set by setValue()

getValue2AsString

public java.lang.String getValue2AsString()

Returns:

value2 in string format

getValue2DateValue

public java.util.Date getValue2DateValue()

Returns:

value2 date object if it is an date object

getValue2IntValue

public int getValue2IntValue()

Returns:

value2 int if it is an date object

setFuzziness

public void setFuzziness(float fuzziness)

must be used for fuzzy search. if no fuzziness is set the default fuzziness for the index is used. the default fuzziness can be set via the index administration

Parameters:

fuzziness - - value between 0.0 and 1.0 where 1.0 is exact search

getFuzziness

public float getFuzziness()

Returns:

fuzziness, that has been set for fuzzy search

specialEqual1

public boolean specialEqual1(IQueryEntry e2)