Package org.neo4j.ogm.cypher.query

Class SortOrder

java.lang.Object

org.neo4j.ogm.cypher.query.SortOrder

public class SortOrder
extends Object

Author:

Vince Bickers, Jonathan D'Orleans

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SortOrder.Direction

Constructor Summary

Constructors

Constructor	Description
SortOrder()	Creates SortOrder with a empty list of SortClause.
SortOrder(String... properties)	Creates SortOrder with a new SortClause containing properties ordered by SortOrder.Direction.ASC.
SortOrder(SortOrder.Direction direction, String... properties)	Creates SortOrder with a new SortClause containing properties ordered by direction.

Method Summary

Modifier and Type	Method	Description
SortOrder	add(String... properties)	Adds a new SortClause containing properties ordered by SortOrder.Direction.ASC.
SortOrder	add(SortOrder.Direction direction, String... properties)	Adds a new SortClause containing properties ordered by direction.
SortOrder	asc(String... properties)	Adds a new SortClause containing properties ordered by SortOrder.Direction.ASC.
String	asString()
SortOrder	desc(String... properties)	Adds a new SortClause containing properties ordered by SortOrder.Direction.DESC.
static SortOrder	fromSortClauses(List<SortClause> sortClauses)
boolean	hasSortClauses()
List<SortClause>	sortClauses()	Return the list of existing SortClause.

Methods inherited from class java.lang.Object

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

Constructor Details

SortOrder

public SortOrder()

Creates SortOrder with a empty list of SortClause.

SortOrder

public SortOrder(String... properties)

Creates SortOrder with a new SortClause containing properties ordered by SortOrder.Direction.ASC.

Parameters:

properties - list of properties ordered by SortOrder.Direction.ASC

SortOrder

public SortOrder(SortOrder.Direction direction,
 String... properties)

Creates SortOrder with a new SortClause containing properties ordered by direction.

Parameters:

direction - the specified SortOrder.Direction can be either ASC or DESC

properties - list of properties ordered by direction

Method Details

fromSortClauses

public static SortOrder fromSortClauses(List<SortClause> sortClauses)

add

public SortOrder add(String... properties)

Adds a new SortClause containing properties ordered by SortOrder.Direction.ASC.

Parameters:

properties - list of properties ordered by SortOrder.Direction.ASC

add

public SortOrder add(SortOrder.Direction direction,
 String... properties)

Adds a new SortClause containing properties ordered by direction.

Parameters:

direction - the specified SortOrder.Direction can be either ASC or DESC

properties - list of properties ordered by direction

asc

public SortOrder asc(String... properties)

Adds a new SortClause containing properties ordered by SortOrder.Direction.ASC.

Parameters:

properties - list of properties ordered by SortOrder.Direction.ASC

desc

public SortOrder desc(String... properties)

Adds a new SortClause containing properties ordered by SortOrder.Direction.DESC.

Parameters:

properties - list of properties ordered by SortOrder.Direction.DESC

sortClauses

public List<SortClause> sortClauses()

Return the list of existing SortClause.

hasSortClauses

public boolean hasSortClauses()

asString

public String asString()