org.eclipse.jpt.jpa.core.context
Interface QueryContainer

All Superinterfaces:

IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model

All Known Subinterfaces:

JavaQueryContainer, OrmQueryContainer

public interface QueryContainer
extends JpaContextNode

Container for named queries and/or named native queries. Used by entities and the orm.xml entity-mappings element.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.2

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	NAMED_NATIVE_QUERIES_LIST
static String	NAMED_QUERIES_LIST

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

RESOURCE_TYPE_TRANSFORMER

Method Summary

NamedNativeQuery	addNamedNativeQuery() Add a new named native query to the container and return it.
NamedNativeQuery	addNamedNativeQuery(int index) Add a new named native query to the container at the specified index and return it.
NamedQuery	addNamedQuery() Add a new named query to the container and return it.
NamedQuery	addNamedQuery(int index) Add a new named query to the container at the specified index and return it.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends NamedNativeQuery>	getNamedNativeQueries() Return the container's named native queries.
int	getNamedNativeQueriesSize() Return the number of named native queries.
org.eclipse.jpt.common.utility.iterable.ListIterable<? extends NamedQuery>	getNamedQueries() Return the container's named queries.
int	getNamedQueriesSize() Return the number of named queries.
Iterable<Query>	getQueries() Return the container's named and named native queries.
void	moveNamedNativeQuery(int targetIndex, int sourceIndex) Move a named native query as specified.
void	moveNamedQuery(int targetIndex, int sourceIndex) Move a named query as specified.
void	removeNamedNativeQuery(int index) Remove from the container the named native query at the specified index.
void	removeNamedNativeQuery(NamedNativeQuery namedNativeQuery) Remove the specified named native query from the container.
void	removeNamedQuery(int index) Remove from the container the named query at the specified index.
void	removeNamedQuery(NamedQuery namedQuery) Remove the specified named query from the container.

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaNode

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

NAMED_QUERIES_LIST

static final String NAMED_QUERIES_LIST

See Also:

Constant Field Values

NAMED_NATIVE_QUERIES_LIST

static final String NAMED_NATIVE_QUERIES_LIST

See Also:

Constant Field Values

Method Detail

getQueries

Iterable<Query> getQueries()

Return the container's named and named native queries.

getNamedQueries

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends NamedQuery> getNamedQueries()

Return the container's named queries.

getNamedQueriesSize

int getNamedQueriesSize()

Return the number of named queries.

addNamedQuery

NamedQuery addNamedQuery()

Add a new named query to the container and return it.

addNamedQuery

NamedQuery addNamedQuery(int index)

Add a new named query to the container at the specified index and return it.

removeNamedQuery

void removeNamedQuery(int index)

Remove from the container the named query at the specified index.

removeNamedQuery

void removeNamedQuery(NamedQuery namedQuery)

Remove the specified named query from the container.

moveNamedQuery

void moveNamedQuery(int targetIndex,
                    int sourceIndex)

Move a named query as specified.

getNamedNativeQueries

org.eclipse.jpt.common.utility.iterable.ListIterable<? extends NamedNativeQuery> getNamedNativeQueries()

Return the container's named native queries.

getNamedNativeQueriesSize

int getNamedNativeQueriesSize()

Return the number of named native queries.

addNamedNativeQuery

NamedNativeQuery addNamedNativeQuery()

Add a new named native query to the container and return it.

addNamedNativeQuery

NamedNativeQuery addNamedNativeQuery(int index)

Add a new named native query to the container at the specified index and return it.

removeNamedNativeQuery

void removeNamedNativeQuery(int index)

Remove from the container the named native query at the specified index.

removeNamedNativeQuery

void removeNamedNativeQuery(NamedNativeQuery namedNativeQuery)

Remove the specified named native query from the container.

moveNamedNativeQuery

void moveNamedNativeQuery(int targetIndex,
                          int sourceIndex)

Move a named native query as specified.