org.opencastproject.util

Class SolrUtils

java.lang.Object

org.opencastproject.util.SolrUtils

public final class SolrUtils
extends Object

Utility class for the solr database.

Field Summary

Fields

Modifier and Type	Field and Description
static Function<String,Option<String>>	clean clean(String) as a function.
static Function<Date,String>	serializeDate serializeDate(java.util.Date) as a function.

Method Summary

Modifier and Type	Method and Description
static String	clean(String q) Clean up the user query input string to avoid invalid input parameters.
static DateFormat	newSolrDateFormat() Return a date format suitable for solr.
static Date	parseDate(String date) Returns the date or null if null was passed in for the date.
static String	serializeDate(Date date) Returns a serialized version of the date or null if null was passed in for the date.
static String	serializeDateRange(Option<Date> startDate, Option<Date> endDate) Returns an expression to search for any date that lies in between startDate and endDate.

Methods inherited from class java.lang.Object

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

Field Detail

clean

public static final Function<String,Option<String>> clean

clean(String) as a function. Return none if string is empty after cleaning.

serializeDate

public static final Function<Date,String> serializeDate

serializeDate(java.util.Date) as a function.

Method Detail

clean

public static String clean(String q)

Clean up the user query input string to avoid invalid input parameters.

Parameters:

q - The input String.

Returns:

The cleaned string.

serializeDate

public static String serializeDate(Date date)

Returns a serialized version of the date or null if null was passed in for the date.

Parameters:

date - the date

Returns:

the serialized date

parseDate

public static Date parseDate(String date)
                      throws ParseException

Returns the date or null if null was passed in for the date.

Parameters:

date - the serialized date in UTC format yyyy-MM-dd'T'HH:mm:ss'Z'

Returns:

the date

Throws:

ParseException - if parsing the date fails

serializeDateRange

public static String serializeDateRange(Option<Date> startDate,
                                        Option<Date> endDate)

Returns an expression to search for any date that lies in between startDate and endDate.

Parameters:

startDate - the start date or none for an infinite left endpoint, "*" in solr query syntax

endDate - the end date or none for an infinite right endpoint, "*" in solr query syntax

Returns:

the serialized search expression

newSolrDateFormat

public static DateFormat newSolrDateFormat()

Return a date format suitable for solr. Format a date as UTC with a granularity of seconds. yyyy-MM-dd'T'HH:mm:ss'Z'