senselogic.sitevision.api.search.query

Interface QueryStringUtil

@Requireable(value="QueryStringUtil")
public interface QueryStringUtil

Query string utility interface.

An instance of the SiteVision class implementing this interface can be obtained via SearchFactory.getQueryStringUtil(). See SearchFactory for how to obtain an instance of the SearchFactory interface.

Since:

SiteVision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
String	getDateAsString(Date aDate) Returns a date formatted according to the Solr date string representation.
String	getFieldQuery(String aFieldName, String aValueExpression) Returns a field query that is properly grouped.
String	removeQuerySyntaxChars(String aQueryString) Removes query syntax characters from a query string and trims the result.
String	splitCollectionToQueryParts(Collection<String> aStringsToSplit, String aSplitExpression) Transforms multiple strings with delimiters to a string that could be used in a field-grouped query expression.
String	splitToQueryParts(String aStringToSplit, String aSplitExpression) Transforms a string with delimiters to a string that could be used in a field-grouped query expression.

Method Detail

removeQuerySyntaxChars

String removeQuerySyntaxChars(String aQueryString)

Removes query syntax characters from a query string and trims the result.

Current syntax characters are:
+ - && || ! ( ) { } [ ] ^ " ~ * ? : \

• The "any" char will be removed, i.e: "ma?nus" -> "manus"
• The "double" chars will be replaced with a "single" char, i.e: "ma&&nus" -> "ma&nus" and "ma||nus" -> "ma|nus"
• Other chars will be replaced with a space. Subsequent syntax chars will only result in one space, e.g: "This is *so* funny!" -> "This is so funny"

Example: "(Site?Vision: *Enterprise)?" -> "SiteVision Enterprise"

Parameters:

aQueryString - a non-null query anExpression

Returns:

a aQueryString without syntax chars (query parsing will most likely not fail), null if aQueryString is null

splitToQueryParts

String splitToQueryParts(String aStringToSplit,
                         String aSplitExpression)

Transforms a string with delimiters to a string that could be used in a field-grouped query expression.

This is a convenience method when you want to query something based on items in a string that are delimited by some token. A typical example is a "keyword" metadata that contains multiple keywords delimited by a comma char.

This method splits the aStringToSplit with the aSplitExpression and each part is then trimmed and appended to the resulting string, separated with a space. Parts that contains a space char is quoted.

Some examples

aStringToSplit	aSplitExpression	Returned
"one"	","	one
"one,two"	","	one two
"one, two"	","	one two
"one, two, three four"	","	one two "three four"
"one"	"aNonMatchingExpression"	one
"one,two"	"aNonMatchingExpression"	one,two
"one, two"	"aNonMatchingExpression"	"one, two"
"one, two, three four"	"aNonMatchingExpression"	"one, two, three four"
null	","	null
null	null	null
"one"	null	one
"one,two"	null	one,two
"one, two"	null	one, two
"one, two, three four"	null	one, two, three four

Parameters:

aStringToSplit - the string that should be transformed

aSplitExpression - the regular expression to split up aStringToSplit in parts

Returns:

the result of the operation. if aStringToSplit is null, null will always be returned. if aSplitExpression is null, aStringToSplit will always be returned. if aSplitExpression is a non-matching expression, a trimmed aStringToSplit will always be returned, and it will be quoted if aStringToSplit contains a space char.

splitCollectionToQueryParts

String splitCollectionToQueryParts(Collection<String> aStringsToSplit,
                                   String aSplitExpression)

Transforms multiple strings with delimiters to a string that could be used in a field-grouped query expression.

This is a convenience method that executes splitToQueryParts(String, String) for a collection of strings and appends each returned value to a combined result, separated with a space. Whitespace only or null values will be ignored.

See splitToQueryParts(String, String) how each string of the collection will be transformed.

Parameters:

aStringsToSplit - a collection of strings

aSplitExpression - the regular expression to split up the strings in the aStringsToSplit collection in parts

Returns:

the result of the splitToQueryParts(String, String) operation for all strings in aStringsToSplit. if aStringsToSplit is null or empty, null will always be returned.

See Also:

splitToQueryParts(String, String)

getFieldQuery

String getFieldQuery(String aFieldName,
                     String aValueExpression)

Returns a field query that is properly grouped.

This method trims the aValueExpression and analyzes the space-separated parts, quoted and unquoted. The result will be a grouped field query if there are multiple parts in aValueExpression and a non-grouped field query if there are only one part in aValueExpression.

Note that this is a convenience method only. Neither field or value will be syntactically checked in any way. The caller of this method is responsible for passing values that the query parser used later on will accept.

Some examples

aFieldName	aValueExpression	Returned
content.analyzed	sitevision	content.analyzed:sitevision
+content.analyzed	sitevision*	+content.analyzed:sitevision*
-content.analyzed	enterprise	-content.analyzed:enterprise
content.analyzed	"sitevision enterprise"	content.analyzed:"sitevision enterprise"
content.analyzed	sitevision enterprise	content.analyzed:(sitevision enterprise)
content.analyzed	portal "sitevision enterprise"	content.analyzed:(portal "sitevision enterprise")

Parameters:

aFieldName - the field expression

aValueExpression - the value expression

Returns:

a properly grouped field query. Note that null will be returned if aFieldName or aValueExpression is null or whitespace only.

getDateAsString

String getDateAsString(Date aDate)

Returns a date formatted according to the Solr date string representation.

All dates in Solr (Lucene) are stored using UTC (zulu time 'Z'). When a date is converted to a string that should be sent to Solr (for example as a part of a query) the timezone must be taken into consideration since no adjustments will be performed by the query parser.

Parameters:

aDate - the date

Returns:

aDate formatted according to Solr's date representation. Returns null if aDate is null.

Since:

SiteVision 4.2