Class QueryMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.QueryMetaData

All Implemented Interfaces:

Serializable

public class QueryMetaData
extends MetaData

Representation of the MetaData of a named Query.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	fetchPlanName	Name of any fetch-plan to use.
protected String	language	Query language.
protected String	name	Name of the query.
protected String	query	The single string query
protected String	resultClass	The result class to use.
protected String	resultMetaDataName	Name for the MetaData defining the mapping of the result set (for JPA SQL).
protected String	scope	Scope of this query (if any).
private static final long	serialVersionUID
protected boolean	unique	Whether the query returns unique.
protected boolean	unmodifiable	Whether the query is unmodifiable.

Fields inherited from class MetaData

EXTENSION_CLASS_CREATETIMESTAMP, EXTENSION_CLASS_CREATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_CREATEUSER, EXTENSION_CLASS_CREATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_CREATEUSER_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH, EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE, EXTENSION_CLASS_MULTITENANT, EXTENSION_CLASS_READ_ONLY, EXTENSION_CLASS_SOFTDELETE, EXTENSION_CLASS_SOFTDELETE_COLUMN_NAME, EXTENSION_CLASS_UPDATETIMESTAMP, EXTENSION_CLASS_UPDATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_UPDATEUSER, EXTENSION_CLASS_UPDATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_UPDATEUSER_COLUMN_NAME, EXTENSION_CLASS_VERSION_FIELD_NAME, EXTENSION_CLASS_VIEW_DEFINITION, EXTENSION_CLASS_VIEW_IMPORTS, EXTENSION_INDEX_COLUMN_ORDERING, EXTENSION_MEMBER_CACHEABLE, EXTENSION_MEMBER_CALENDAR_ONE_COLUMN, EXTENSION_MEMBER_CASCADE_ATTACH, EXTENSION_MEMBER_CASCADE_DETACH, EXTENSION_MEMBER_CASCADE_PERSIST, EXTENSION_MEMBER_CASCADE_REFRESH, EXTENSION_MEMBER_COMPARATOR_NAME, EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS, EXTENSION_MEMBER_CREATE_TIMESTAMP, EXTENSION_MEMBER_CREATE_USER, EXTENSION_MEMBER_ENUM_VALUE_GETTER, EXTENSION_MEMBER_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_INSERTABLE, EXTENSION_MEMBER_KEY_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_LIST_ORDERING, EXTENSION_MEMBER_RELATION_DISCRIM_COLUMN, EXTENSION_MEMBER_RELATION_DISCRIM_PK, EXTENSION_MEMBER_RELATION_DISCRIM_VALUE, EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL, EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED, EXTENSION_MEMBER_TYPE_CONVERTER_NAME, EXTENSION_MEMBER_UPDATE_TIMESTAMP, EXTENSION_MEMBER_UPDATE_USER, EXTENSION_MEMBER_UPDATEABLE, EXTENSION_MEMBER_VALUE_IMPLEMENTATION_CLASSES, EXTENSION_VERSION_NUMBER_INITIAL_VALUE, extensions, metaDataState, parent, VENDOR_NAME

Constructor Summary

Constructors

Constructor	Description
QueryMetaData(String name)	Constructor for a query of the specified name.

Method Summary

Modifier and Type	Method	Description
String	getFetchPlanName()
String	getLanguage()
String	getName()
String	getQuery()
String	getResultClass()
String	getResultMetaDataName()
String	getScope()
boolean	isUnique()
boolean	isUnmodifiable()
QueryMetaData	setFetchPlanName(String fpName)
QueryMetaData	setLanguage(String language)
QueryMetaData	setQuery(String query)
QueryMetaData	setResultClass(String resultClass)
QueryMetaData	setResultMetaDataName(String mdName)
QueryMetaData	setScope(String scope)
QueryMetaData	setUnique(boolean unique)
QueryMetaData	setUnique(String unique)
QueryMetaData	setUnmodifiable(boolean unmodifiable)
QueryMetaData	setUnmodifiable(String unmodifiable)

Methods inherited from class MetaData

addExtension, addExtensions, getExtensions, getMetaDataManager, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, removeExtension, setExtensions, setInitialised, setParent, setPopulated, setUsed

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

scope

protected String scope

Scope of this query (if any).

name

protected String name

Name of the query.

language

protected String language

Query language.

unmodifiable

protected boolean unmodifiable

Whether the query is unmodifiable.

query

protected String query

The single string query

resultClass

protected String resultClass

The result class to use. Only applies to SQL.

resultMetaDataName

protected String resultMetaDataName

Name for the MetaData defining the mapping of the result set (for JPA SQL).

unique

protected boolean unique

Whether the query returns unique. Only applies to SQL.

fetchPlanName

protected String fetchPlanName

Name of any fetch-plan to use.

Constructor Details

QueryMetaData

public QueryMetaData(String name)

Constructor for a query of the specified name. Set fields using setters, before populate().

Parameters:

name - The Query name

Method Details

getScope

public String getScope()

setScope

public QueryMetaData setScope(String scope)

getName

public String getName()

getLanguage

public String getLanguage()

setLanguage

public QueryMetaData setLanguage(String language)

isUnmodifiable

public boolean isUnmodifiable()

setUnmodifiable

public QueryMetaData setUnmodifiable(boolean unmodifiable)

setUnmodifiable

public QueryMetaData setUnmodifiable(String unmodifiable)

getQuery

public String getQuery()

setQuery

public QueryMetaData setQuery(String query)

getResultClass

public String getResultClass()

setResultClass

public QueryMetaData setResultClass(String resultClass)

getResultMetaDataName

public String getResultMetaDataName()

setResultMetaDataName

public QueryMetaData setResultMetaDataName(String mdName)

isUnique

public boolean isUnique()

setUnique

public QueryMetaData setUnique(boolean unique)

setUnique

public QueryMetaData setUnique(String unique)

getFetchPlanName

public String getFetchPlanName()

setFetchPlanName

public QueryMetaData setFetchPlanName(String fpName)