org.apache.clerezza.rdf.cris

Class SortSpecification

java.lang.Object

org.apache.clerezza.rdf.cris.SortSpecification

public class SortSpecification
extends Object

Specifies CRIS result sorting.

Author:

daniel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortSpecification.SortEntry A SortSPecification Entry.
static class	SortSpecification.Type Specifies the type of the terms to be sorted, or special types such as CUSTOM

Field Summary

Fields

Modifier and Type	Field and Description
static SortSpecification.SortEntry	INDEX_ORDER Sort by indexing order (first indexed resource is first, etc.).
static SortSpecification.SortEntry	RELEVANCE Sort by Lucene document score.

Constructor Summary

Constructors

Constructor and Description
SortSpecification() Creates a new SortSpecification.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(SortSpecification.SortEntry entry) Add a SortEntry.
void	add(VirtualProperty property, SortSpecification.Type type) Add a property to sort on.
void	add(VirtualProperty property, SortSpecification.Type type, boolean reverse) Add a property to sort on.
void	clear() Clear the sort specification.
void	remove(SortSpecification.SortEntry entry) Remove a SortEntry.
void	remove(VirtualProperty property, SortSpecification.Type type) Remove the property with specified type.
void	remove(VirtualProperty property, SortSpecification.Type type, boolean reverse) Remove the property with specified type.
int	size() Returns the number of added entries.

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_ORDER

public static final SortSpecification.SortEntry INDEX_ORDER

Sort by indexing order (first indexed resource is first, etc.).

RELEVANCE

public static final SortSpecification.SortEntry RELEVANCE

Sort by Lucene document score.

Constructor Detail

SortSpecification

public SortSpecification()

Creates a new SortSpecification.

Method Detail

add

public void add(VirtualProperty property,
       SortSpecification.Type type)

Add a property to sort on. Note: The order of addition determines the search priority. The property to search on has to be indexed. The indexed value should not be tokenized. The property's value is interpreted according to specified type.

Parameters:

property - the property

type - the type

add

public void add(VirtualProperty property,
       SortSpecification.Type type,
       boolean reverse)

Add a property to sort on. Note: The order of addition determines the search priority. The property to search on has to be indexed. The indexed value should not be tokenized. The property's value is interpreted according to specified type.

Parameters:

property - the property

type - the type

reverse - whether to sort in reverse.

add

public void add(SortSpecification.SortEntry entry)

Add a SortEntry. Note: The order of addition determines the search priority.

remove

public void remove(VirtualProperty property,
          SortSpecification.Type type)

Remove the property with specified type.

Parameters:

property - the property.

type - the type.

remove

public void remove(VirtualProperty property,
          SortSpecification.Type type,
          boolean reverse)

Remove the property with specified type.

Parameters:

property - the property.

type - the type.

reverse - whether the sort is specified in reverse.

remove

public void remove(SortSpecification.SortEntry entry)

Remove a SortEntry.

clear

public void clear()

Clear the sort specification.

size

public int size()

Returns the number of added entries.

Returns:

the number of entries.