de.espirit.or.query
Interface Select

All Superinterfaces:

Cloneable, Serializable

public interface Select
extends Cloneable, Serializable

Since:

4.0.17

Method Summary

void	add(de.espirit.or.query.FetchMode mode)
void	add(de.espirit.or.query.Order order)
void	add(de.espirit.or.query.Parameter parameter)
Select	applyLanguage(String languageAbbreviation) Make a clone of this select and replace all place holders %lang% contained in constaints with the given languageAbbreviation
void	clearOrdering()
Select	clone() Return a deep copy of this select
boolean	containsParameter(String identifier)
de.espirit.or.query.Constraint	getConstraint() Return the constraint defined by this select.
String	getEntityTypeName() Return the name of the entity type which entities in the result set belong to.
List<de.espirit.or.query.FetchMode>	getFetchModes()
int	getFetchSize() Return the fetch size which will applied to the JDBC ResultSet to retrieve data from the database.
int	getMaxResultCount() The maximum number of entities this select will return.
List<de.espirit.or.query.Order>	getOrders()
de.espirit.or.query.Parameter	getParameter(String identifier) Return the parameter with the given identifier.
Collection<de.espirit.or.query.Parameter>	getParameters() Return all parameters defined by this select.
Object	getParameterValue(String identifier)
long	getQueryTime()
String	getXML()
boolean	isDeprecated() Return true if this select is constructed from a 3.1 query document.
boolean	isOrdered(String attributeName) Return true if an order of the attribute attributeName is already defined in this select.
void	resetQueryTime()
void	setConstraint(de.espirit.or.query.Constraint constraint) Set the select constraint to constraint.
void	setDeprecated(boolean flag) Set this select to deprecated or not.
void	setFetchSize(int size)
void	setMaxResultCount(int maxResultCount) Set the maximum number of entities this select will return.
void	setParameter(String identifier, Object value)
void	setQueryTime(long time)

Method Detail

isDeprecated

boolean isDeprecated()

Return true if this select is constructed from a 3.1 query document.

Since:

4.0.17

setDeprecated

void setDeprecated(boolean flag)

Set this select to deprecated or not. A deprcated select is the one was constructed from a 3.1 query.

Since:

4.0.17

getEntityTypeName

String getEntityTypeName()

Return the name of the entity type which entities in the result set belong to. Each select produces results from one entity type (table) even more than one entity types can be involved in the constraint of the select.

Since:

4.0.17

setConstraint

void setConstraint(de.espirit.or.query.Constraint constraint)
                   throws de.espirit.or.ORException

Set the select constraint to constraint.

Throws:

de.espirit.or.ORException

Since:

4.0.17

getConstraint

de.espirit.or.query.Constraint getConstraint()

Return the constraint defined by this select.

Since:

4.0.17

getParameter

de.espirit.or.query.Parameter getParameter(@NotNull
                                           String identifier)
                                           throws de.espirit.or.ORException

Return the parameter with the given identifier.

Throws:

de.espirit.or.ORException

Since:

4.0.17

getParameters

Collection<de.espirit.or.query.Parameter> getParameters()

Return all parameters defined by this select.

Since:

4.0.17

add

void add(@NotNull
         de.espirit.or.query.Parameter parameter)

Since:

4.0.17

add

void add(@NotNull
         de.espirit.or.query.FetchMode mode)

Since:

4.0.17

getFetchModes

List<de.espirit.or.query.FetchMode> getFetchModes()

Since:

4.0.17

getParameterValue

Object getParameterValue(@NotNull
                         String identifier)

Since:

4.0.17

setParameter

void setParameter(@NotNull
                  String identifier,
                  Object value)
                  throws de.espirit.or.ORException

Throws:

de.espirit.or.ORException

Since:

4.0.17

getOrders

@NotNull
List<de.espirit.or.query.Order> getOrders()

Since:

4.0.17

isOrdered

boolean isOrdered(@NotNull
                  String attributeName)

Return true if an order of the attribute attributeName is already defined in this select.

Since:

4.0.30

add

void add(@NotNull
         de.espirit.or.query.Order order)

Since:

4.0.17

getQueryTime

long getQueryTime()

Since:

4.0.17

setQueryTime

void setQueryTime(long time)

Since:

4.0.29

resetQueryTime

void resetQueryTime()

Since:

4.0.29

setFetchSize

void setFetchSize(int size)

Since:

4.0.17

getFetchSize

int getFetchSize()

Return the fetch size which will applied to the JDBC ResultSet to retrieve data from the database.

Since:

4.0.17

getXML

String getXML()

Since:

4.0.17

clearOrdering

void clearOrdering()

Since:

4.0.17

containsParameter

boolean containsParameter(@NotNull
                          String identifier)

Since:

4.0.17

clone

Select clone()

Return a deep copy of this select

Since:

4.0.17

getMaxResultCount

int getMaxResultCount()

The maximum number of entities this select will return. A value of 0 means no restriction (default).

Since:

4.0.19

See Also:

Select.setMaxResultCount(int)

setMaxResultCount

void setMaxResultCount(int maxResultCount)

Set the maximum number of entities this select will return. A value of 0 means no restriction (default).

Since:

4.0.19

See Also:

Select.getMaxResultCount()

applyLanguage

Select applyLanguage(@NotNull
                     String languageAbbreviation)

Make a clone of this select and replace all place holders %lang% contained in constaints with the given languageAbbreviation

Returns:

the clone of this select for the language languageAbbreviation

Since:

4.0.26