org.nuiton.wikitty
Class Criteria

java.lang.Object
  org.nuiton.wikitty.Criteria

All Implemented Interfaces:

java.io.Serializable

public class Criteria
extends java.lang.Object
implements java.io.Serializable

Criteria represent the search on the wikitty with restriction on field and informations on facet, pagination and sorting.

For search multiple extension use ALL_EXTENSIONS as extension name and specify field type.

Example : Criteria.ALL_EXTENSIONS + Criteria.SEPARATOR + + Criteria.SEPARATOR + FieldType.TYPE.

Version:

$Revision: 429 $ Last update: $Date: 2010-10-20 11:46:15 +0200 (mer., 20 oct. 2010) $ by : $Author: sletellier $

Author:

poussin

See Also:

Serialized Form

Field Summary

static int	ALL_ELEMENTS Use to not limit result.
static java.lang.String	ALL_EXTENSIONS Search on all extension.
static java.lang.String	ALL_VALUES Search on all values.
protected int	endIndex Last index to get result.
protected java.util.List<Criteria>	facetCriteria Facet on criteria.
protected java.util.List<java.lang.String>	facetField Facet on field.
protected int	firstIndex First index to get result.
protected java.lang.String	name Criteria can have name this help for presentation and is very useful for facet created by criteria.
protected Restriction	restriction All restriction on fields.
static java.lang.String	SEPARATOR Separator between extension name, field name and type.
protected java.util.List<java.lang.String>	sortAscending Sort ascending on fields.
protected java.util.List<java.lang.String>	sortDescending Sort descending on fields.

Constructor Summary

Criteria()
Default constructor.

Criteria(java.lang.String name)
Create named criteria.

Method Summary

Criteria	addFacetCriteria(Criteria criteria)
Criteria	addFacetField(java.lang.String field)
Criteria	addSortAscending(java.lang.String field)
Criteria	addSortDescending(java.lang.String field)
static Criteria	fromXML(java.lang.String xml) Deserialize xml to criteria.
int	getEndIndex()
java.util.List<Criteria>	getFacetCriteria()
java.util.List<java.lang.String>	getFacetField()
int	getFirstIndex()
java.lang.String	getName()
Restriction	getRestriction()
java.util.List<java.lang.String>	getSortAscending()
java.util.List<java.lang.String>	getSortDescending()
Criteria	setEndIndex(int endIndex)
Criteria	setFacetCriteria(Criteria[] facetCriteria)
Criteria	setFacetField(java.lang.String[] facetField)
Criteria	setFirstIndex(int firstIndex)
void	setName(java.lang.String name)
void	setRestriction(Restriction restriction)
Criteria	setSortAscending(java.lang.String[] sortAscending)
Criteria	setSortDescending(java.lang.String[] sortDescending)
java.lang.String	toString()
static java.lang.String	toXML(Criteria criteria) Serialize criteria to xml.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_ELEMENTS

public static final int ALL_ELEMENTS

Use to not limit result.

See Also:

Constant Field Values

ALL_EXTENSIONS

public static final java.lang.String ALL_EXTENSIONS

Search on all extension.

See Also:

Constant Field Values

ALL_VALUES

public static final java.lang.String ALL_VALUES

Search on all values.

See Also:

Constant Field Values

SEPARATOR

public static final java.lang.String SEPARATOR

Separator between extension name, field name and type.

See Also:

Constant Field Values

name

protected java.lang.String name

Criteria can have name this help for presentation and is very useful for facet created by criteria.

restriction

protected Restriction restriction

All restriction on fields.

firstIndex

protected int firstIndex

First index to get result.

endIndex

protected int endIndex

Last index to get result.

facetCriteria

protected java.util.List<Criteria> facetCriteria

Facet on criteria.

facetField

protected java.util.List<java.lang.String> facetField

Facet on field.

sortAscending

protected java.util.List<java.lang.String> sortAscending

Sort ascending on fields.

sortDescending

protected java.util.List<java.lang.String> sortDescending

Sort descending on fields.

Constructor Detail

Criteria

public Criteria()

Default constructor.

Criteria

public Criteria(java.lang.String name)

Create named criteria.

Parameters:

name - criteria name

Method Detail

fromXML

public static Criteria fromXML(java.lang.String xml)

Deserialize xml to criteria.

Parameters:

xml - xml to deserialize

Returns:

criteria criteria

toXML

public static java.lang.String toXML(Criteria criteria)

Serialize criteria to xml.

Parameters:

criteria - criteria to serialize

Returns:

xml string

getRestriction

public Restriction getRestriction()

setRestriction

public void setRestriction(Restriction restriction)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getFirstIndex

public int getFirstIndex()

setFirstIndex

public Criteria setFirstIndex(int firstIndex)

getEndIndex

public int getEndIndex()

setEndIndex

public Criteria setEndIndex(int endIndex)

getFacetCriteria

public java.util.List<Criteria> getFacetCriteria()

addFacetCriteria

public Criteria addFacetCriteria(Criteria criteria)

setFacetCriteria

public Criteria setFacetCriteria(Criteria[] facetCriteria)

getFacetField

public java.util.List<java.lang.String> getFacetField()

addFacetField

public Criteria addFacetField(java.lang.String field)

setFacetField

public Criteria setFacetField(java.lang.String[] facetField)

getSortAscending

public java.util.List<java.lang.String> getSortAscending()

addSortAscending

public Criteria addSortAscending(java.lang.String field)

setSortAscending

public Criteria setSortAscending(java.lang.String[] sortAscending)

getSortDescending

public java.util.List<java.lang.String> getSortDescending()

addSortDescending

public Criteria addSortDescending(java.lang.String field)

setSortDescending

public Criteria setSortDescending(java.lang.String[] sortDescending)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object