org.sharengo.wikitty
Class Criteria

java.lang.Object
  org.sharengo.wikitty.Criteria

All Implemented Interfaces:

Serializable

public class Criteria
extends Object
implements Serializable

Criteria represent the search on the wikitty with restriction on field and informations on facet, paggination and sortting.

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: 5 $ Last update: $Date: 2010-04-16 11:59:15 +0200 (ven., 16 avril 2010) $ by : $Author: echatellier $

Author:

poussin

See Also:

Serialized Form

Field Summary

static int	ALL_ELEMENTS Use to not limit result
static String	ALL_EXTENSIONS Search on all extension
static String	ALL_VALUES Search on all values
protected String	name Criteria can have name this help for presentation and is very useful for facet created by criteria
static String	SEPARATOR Separator between extension name, field name and type

Constructor Summary

Criteria()
Default constuctor

Criteria(String name)
Create named criteria

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

ALL_ELEMENTS

public static int ALL_ELEMENTS

Use to not limit result

ALL_EXTENSIONS

public static String ALL_EXTENSIONS

Search on all extension

ALL_VALUES

public static String ALL_VALUES

Search on all values

SEPARATOR

public static String SEPARATOR

Separator between extension name, field name and type

name

protected String name

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

Constructor Detail

Criteria

public Criteria()

Default constuctor

Criteria

public Criteria(String name)

Create named criteria

Parameters:

name -

Method Detail

fromXML

public static Criteria fromXML(String xml)

Deserialize xml to criteria

Parameters:

xml -

Returns:

criteria

toXML

public static String toXML(Criteria criteria)

Serialize criteria to xml

Parameters:

criteria -

Returns:

xml string

getRestriction

public Restriction getRestriction()

setRestriction

public void setRestriction(Restriction restriction)

getName

public String getName()

setName

public void setName(String name)

getFirstIndex

public int getFirstIndex()

setFirstIndex

public Criteria setFirstIndex(int firstIndex)

getEndIndex

public int getEndIndex()

setEndIndex

public Criteria setEndIndex(int endIndex)

getFacetCriteria

public List<Criteria> getFacetCriteria()

addFacetCriteria

public Criteria addFacetCriteria(Criteria criteria)

setFacetCriteria

public Criteria setFacetCriteria(Criteria[] facetCriteria)

getFacetField

public List<String> getFacetField()

addFacetField

public Criteria addFacetField(String field)

setFacetField

public Criteria setFacetField(String[] facetField)

getSortAscending

public List<String> getSortAscending()

addSortAscending

public Criteria addSortAscending(String field)

setSortAscending

public Criteria setSortAscending(String[] sortAscending)

getSortDescending

public List<String> getSortDescending()

addSortDescending

public Criteria addSortDescending(String field)

setSortDescending

public Criteria setSortDescending(String[] sortDescending)