Module io.github.mmm.entity.bean

Package io.github.mmm.entity.bean.sql.select

Class OrderBy<E extends EntityBean>

java.lang.Object

io.github.mmm.marshall.AbstractMarshallingObject

io.github.mmm.entity.bean.sql.AbstractClause

io.github.mmm.entity.bean.sql.AbstractTypedClause<E,OrderBy<E>>

io.github.mmm.entity.bean.sql.select.OrderBy<E>

Type Parameters:

E - type of the entity.

All Implemented Interfaces:

Clause, MainClause<E>, TypedClause<E>, io.github.mmm.marshall.MarshallableObject, io.github.mmm.marshall.Marshaller<Object>, io.github.mmm.marshall.Marshalling<Object>, io.github.mmm.marshall.MarshallingObject, io.github.mmm.marshall.UnmarshallableObject, io.github.mmm.marshall.Unmarshaller<Object>

public class OrderBy<E extends EntityBean>
extends AbstractTypedClause<E,OrderBy<E>>
implements MainClause<E>

A OrderBy-Clause of an SQL SelectStatement.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME_ORDER_BY	Name of OrderBy for marshaling.
static String	NAME_ORDERINGS	Name of getOrderings() for marshaling.

Constructor Summary

Constructors

Constructor	Description
OrderBy(SelectStatement<E> statement)	The constructor.

Method Summary

Modifier and Type	Method	Description
OrderBy<E>	and(io.github.mmm.property.criteria.CriteriaOrdering ordering)
OrderBy<E>	and(io.github.mmm.property.criteria.CriteriaOrdering... criteriaOrderings)
SelectStatement<E>	get()
protected String	getMarshallingName()
List<io.github.mmm.property.criteria.CriteriaOrdering>	getOrderings()
boolean	isOmit()
protected void	readProperty(io.github.mmm.marshall.StructuredReader reader, String name)
protected void	writeProperties(io.github.mmm.marshall.StructuredWriter writer)

Methods inherited from class io.github.mmm.entity.bean.sql.AbstractTypedClause

self

Methods inherited from class io.github.mmm.entity.bean.sql.AbstractClause

toString

Methods inherited from class io.github.mmm.marshall.AbstractMarshallingObject

read, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.mmm.marshall.MarshallableObject

write, writeObject

Methods inherited from interface io.github.mmm.marshall.UnmarshallableObject

read, readObject

Field Detail

NAME_ORDER_BY

public static final String NAME_ORDER_BY

Name of OrderBy for marshaling.

See Also:

Constant Field Values

NAME_ORDERINGS

public static final String NAME_ORDERINGS

Name of getOrderings() for marshaling.

See Also:

Constant Field Values

Constructor Detail

OrderBy

public OrderBy(SelectStatement<E> statement)

The constructor.

Parameters:

statement - the owning SelectStatement.

Method Detail

getMarshallingName

protected String getMarshallingName()

Specified by:

getMarshallingName in class AbstractClause

Returns:

the name of the property for this clause.

isOmit

public boolean isOmit()

Specified by:

isOmit in interface Clause

Returns:

true if this Clause should be omitted as it is optional and entirely empty, false otherwise.

and

public OrderBy<E> and(io.github.mmm.property.criteria.CriteriaOrdering ordering)

Parameters:

ordering - the CriteriaOrdering to add.

Returns:

this OrderBy-class itself for fluent API calls.

and

public OrderBy<E> and(io.github.mmm.property.criteria.CriteriaOrdering... criteriaOrderings)

Parameters:

criteriaOrderings - the CriteriaOrderings to add.

Returns:

this OrderBy-class itself for fluent API calls.

getOrderings

public List<io.github.mmm.property.criteria.CriteriaOrdering> getOrderings()

Returns:

the List of CriteriaOrderings to order by.

get

public SelectStatement<E> get()

Specified by:

get in interface MainClause<E extends EntityBean>

Returns:

the actual Statement containing all Clauses and representing your entire SQL.

writeProperties

protected void writeProperties(io.github.mmm.marshall.StructuredWriter writer)

Overrides:

writeProperties in class AbstractClause

readProperty

protected void readProperty(io.github.mmm.marshall.StructuredReader reader,
                            String name)

Overrides:

readProperty in class AbstractClause