senselogic.sitevision.api.search

Interface SearchFieldUtil

Deprecated.

use the typed methods in SearchHit instead when extracting values from a search result.

@Deprecated
public interface SearchFieldUtil

Utility class for converting String values extracted from search fields.

Note! SearchHit has - as of Sitevision 3.0 - several typed getField methods that you would typically instead of this interface when you want to get "non-String" values! More information about field values/types

Since:

Sitevision 2.6.2, 2.7_06

Author:

Magnus Lövgren

See Also:

SearchHit.getBooleanField(String), SearchHit.getDateField(String), SearchHit.getFloatField(String), SearchHit.getLongField(String)

Method Summary

Modifier and Type	Method and Description
Calendar	dateFieldToCalendar(String aDateFieldValue) Deprecated. Returns the Calendar for a string field that contains a date value generated via Lucene's DateTools class.
Date	dateFieldToDate(String aDateFieldValue) Deprecated. Returns the Date for a string field that contains a date value generated via Lucene's DateTools class.
Double	doubleFieldToDouble(String aDoubleFieldValue) Deprecated. Returns the Double for a string field that contains a double value generated to be a sortable search value.
Integer	intFieldToInt(String anIntFieldValue) Deprecated. Returns the Integer for a string field that contains a integer value generated via Lucene's NumberTools (i.e. long) class.
Locale	localeFieldToLocale(String aLocaleFieldValue) Deprecated. use LocaleUtil.getLocaleByString(String) instead
Long	longFieldToLong(String aLongFieldValue) Deprecated. Returns the Long for a string field that contains a long value generated via Lucene's NumberTools class.

Method Detail

dateFieldToDate

Date dateFieldToDate(String aDateFieldValue)

Deprecated.

Returns the Date for a string field that contains a date value generated via Lucene's DateTools class.

Parameters:

aDateFieldValue - the String that should be converted to a Date

Returns:

aDateFieldValue as Date, or null if indeterminable.

dateFieldToCalendar

Calendar dateFieldToCalendar(String aDateFieldValue)

Deprecated.

Returns the Calendar for a string field that contains a date value generated via Lucene's DateTools class.

Parameters:

aDateFieldValue - the String that should be converted to a Calendar

Returns:

aDateFieldValue as Calendar, or null if indeterminable.

localeFieldToLocale

Locale localeFieldToLocale(String aLocaleFieldValue)

Deprecated. use LocaleUtil.getLocaleByString(String) instead

Returns the Locale for a string field that contains a locale-based value that contains language ("en") or language and country ("en_US").

A toString() on a english american locale returns the String "en_US", but to create a locale from that string you can NOT just create it by doing: new Locale("en_US"). You must split language (en) and country (US) since the proper way of creating the Locale is: new Locale("en", "US"). Language must be lowercased and country must be uppercased. This method will handle that (i.e. aLocaleFieldValue == "EN_us" -> new Locale("en", "US")).

Note! This method does NOT handle variants!

Parameters:

aLocaleFieldValue - a String containing a language - or a language and country, separated with underscrore.

Returns:

a Locale matching aLocaleFieldValue, returns null if indeterminable (e.g aLocaleFieldValue is null)

intFieldToInt

Integer intFieldToInt(String anIntFieldValue)

Deprecated.

Returns the Integer for a string field that contains a integer value generated via Lucene's NumberTools (i.e. long) class.

Parameters:

anIntFieldValue - the String that should be converted to a Integer

Returns:

anIntFieldValue as Integer, or null if indeterminable.

Since:

Sitevision 2.6.2, 2.7.2

longFieldToLong

Long longFieldToLong(String aLongFieldValue)

Deprecated.

Returns the Long for a string field that contains a long value generated via Lucene's NumberTools class.

Parameters:

aLongFieldValue - the String that should be converted to a Long

Returns:

aLongFieldValue as Long, or null if indeterminable.

Since:

Sitevision 2.6.2, 2.7.2

doubleFieldToDouble

Double doubleFieldToDouble(String aDoubleFieldValue)

Deprecated.

Returns the Double for a string field that contains a double value generated to be a sortable search value.

Parameters:

aDoubleFieldValue - the String that should be converted to a Double

Returns:

aDoubleFieldValue as Double, or null if indeterminable.

Since:

Sitevision 2.6.2, 2.7.2