org.exolab.castor.mapping.xml
Class NamedQuery

java.lang.Object
  org.exolab.castor.mapping.xml.NamedQuery

All Implemented Interfaces:

java.io.Serializable

public class NamedQuery
extends java.lang.Object
implements java.io.Serializable

Class NamedQuery.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

NamedQuery()

Method Summary

void	addQueryHint(int index, QueryHint vQueryHint) Method addQueryHint
void	addQueryHint(QueryHint vQueryHint) Method addQueryHint
void	clearQueryHint() Method clearQueryHint
java.util.Enumeration	enumerateQueryHint() Method enumerateQueryHint
java.lang.String	getName() Returns the value of field 'name'.
java.lang.String	getQuery() Returns the value of field 'query'.
QueryHint[]	getQueryHint() Method getQueryHint
QueryHint	getQueryHint(int index) Method getQueryHint
int	getQueryHintCount() Method getQueryHintCount
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
boolean	removeQueryHint(QueryHint vQueryHint) Method removeQueryHint
void	setName(java.lang.String name) Sets the value of field 'name'.
void	setQuery(java.lang.String query) Sets the value of field 'query'.
void	setQueryHint(int index, QueryHint vQueryHint) Method setQueryHint
void	setQueryHint(QueryHint[] queryHintArray) Method setQueryHint
static NamedQuery	unmarshal(java.io.Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedQuery

public NamedQuery()

Method Detail

addQueryHint

public void addQueryHint(QueryHint vQueryHint)
                  throws java.lang.IndexOutOfBoundsException

Method addQueryHint

Parameters:

vQueryHint -

Throws:

java.lang.IndexOutOfBoundsException

addQueryHint

public void addQueryHint(int index,
                         QueryHint vQueryHint)
                  throws java.lang.IndexOutOfBoundsException

Method addQueryHint

Parameters:

index -

vQueryHint -

Throws:

java.lang.IndexOutOfBoundsException

clearQueryHint

public void clearQueryHint()

Method clearQueryHint

enumerateQueryHint

public java.util.Enumeration enumerateQueryHint()

Method enumerateQueryHint

Returns:

Enumeration

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

String

getQuery

public java.lang.String getQuery()

Returns the value of field 'query'.

Returns:

String

getQueryHint

public QueryHint getQueryHint(int index)
                       throws java.lang.IndexOutOfBoundsException

Method getQueryHint

Parameters:

index -

Returns:

QueryHint

Throws:

java.lang.IndexOutOfBoundsException

getQueryHint

public QueryHint[] getQueryHint()

Method getQueryHint

Returns:

QueryHint

getQueryHintCount

public int getQueryHintCount()

Method getQueryHintCount

Returns:

int

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws MarshalException,
                    ValidationException

Method marshal

Parameters:

out -

Throws:

MarshalException

ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    MarshalException,
                    ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

MarshalException

ValidationException

removeQueryHint

public boolean removeQueryHint(QueryHint vQueryHint)

Method removeQueryHint

Parameters:

vQueryHint -

Returns:

boolean

setName

public void setName(java.lang.String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setQuery

public void setQuery(java.lang.String query)

Sets the value of field 'query'.

Parameters:

query - the value of field 'query'.

setQueryHint

public void setQueryHint(int index,
                         QueryHint vQueryHint)
                  throws java.lang.IndexOutOfBoundsException

Method setQueryHint

Parameters:

index -

vQueryHint -

Throws:

java.lang.IndexOutOfBoundsException

setQueryHint

public void setQueryHint(QueryHint[] queryHintArray)

Method setQueryHint

Parameters:

queryHintArray -

unmarshal

public static NamedQuery unmarshal(java.io.Reader reader)
                            throws MarshalException,
                                   ValidationException

Method unmarshal

Parameters:

reader -

Returns:

NamedQuery

Throws:

MarshalException

ValidationException

validate

public void validate()
              throws ValidationException

Method validate

Throws:

ValidationException