org.jpox.metadata
Class QueryMetaData

java.lang.Object
  org.jpox.metadata.MetaData
      org.jpox.metadata.ExtendableMetaData
          org.jpox.metadata.QueryMetaData

All Implemented Interfaces:

java.io.Serializable

public class QueryMetaData
extends ExtendableMetaData

Representation of the MetaData of a named Query.

MetaData Element

The MetaData Element represented here is as follows

Since:

1.1

Version:

$Revision: 1.8 $

See Also:

Serialized Form

Field Summary

protected QueryLanguage	language Language tag value.
protected java.lang.String	name Query name
protected java.lang.String	query The single string query
protected java.lang.String	resultClass The result class to use.
protected boolean	unique Whether the query returns unique.
protected boolean	unmodifiable unmodifiable tag value.

Fields inherited from class org.jpox.metadata.ExtendableMetaData

extensions, JPOX_VENDOR_NAME

Fields inherited from class org.jpox.metadata.MetaData

LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent

Constructor Summary

QueryMetaData(ExtendableMetaData parent, java.lang.String name, java.lang.String language, java.lang.String unmodifiable, java.lang.String resultClass, java.lang.String unique)
Constructor.

Method Summary

QueryLanguage	getLanguage() Accessor for the language
java.lang.String	getName() Accessor for the class name.
java.lang.String	getQuery() Accessor for the query
java.lang.String	getResultClass() Accessor for the result class
boolean	isUnique() Accessor for the unique tag value.
boolean	isUnmodifiable() Accessor for the unmodifiable tag value.
void	setQuery(java.lang.String query) Mutator for the query
java.lang.String	toString() Returns a string representation of the object.
java.lang.String	toString(java.lang.String prefix, java.lang.String indent) Returns a string representation of the object.

Methods inherited from class org.jpox.metadata.ExtendableMetaData

addExtension, addExtension, getExtension, getExtensions, getNoOfExtensions, getValueForExtension, getValuesForExtension, getValuesForExtensionStartingWith, hasExtension, removeExtension

Methods inherited from class org.jpox.metadata.MetaData

getParent, initialise, isCreated, isInitialised, isPopulated, isUsed, populate, setInitialised, setPopulated, setUsed

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final java.lang.String name

Query name

language

protected QueryLanguage language

Language tag value.

unmodifiable

protected boolean unmodifiable

unmodifiable tag value.

query

protected java.lang.String query

The single string query

resultClass

protected java.lang.String resultClass

The result class to use. Only applies to SQL.

unique

protected boolean unique

Whether the query returns unique. Onyl applies to SQL.

Constructor Detail

QueryMetaData

public QueryMetaData(ExtendableMetaData parent,
                     java.lang.String name,
                     java.lang.String language,
                     java.lang.String unmodifiable,
                     java.lang.String resultClass,
                     java.lang.String unique)

Constructor.

Parameters:

parent - the parent of the Query

name - The Query name

language - The language name

unmodifiable - The unmodifiable tag

resultClass - The result class

unique - The unique tag

Method Detail

getName

public java.lang.String getName()

Accessor for the class name.

Returns:

class name

getLanguage

public QueryLanguage getLanguage()

Accessor for the language

Returns:

language tag value

isUnmodifiable

public boolean isUnmodifiable()

Accessor for the unmodifiable tag value.

Returns:

unmodifiable tag value

getQuery

public java.lang.String getQuery()

Accessor for the query

Returns:

The query

getResultClass

public java.lang.String getResultClass()

Accessor for the result class

Returns:

result class

isUnique

public boolean isUnique()

Accessor for the unique tag value.

Returns:

unique tag value

setQuery

public void setQuery(java.lang.String query)

Mutator for the query

Parameters:

query - The query

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class ExtendableMetaData

Returns:

a string representation of the object.

toString

public java.lang.String toString(java.lang.String prefix,
                                 java.lang.String indent)

Returns a string representation of the object.

Overrides:

toString in class ExtendableMetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.