org.apache.oodt.xmlquery

Class QueryHeader

java.lang.Object

org.apache.oodt.xmlquery.QueryHeader

All Implemented Interfaces:

Serializable, Cloneable, Documentable

public class QueryHeader
extends Object
implements Serializable, Cloneable, Documentable

Header of a query

Author:

Kelly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryHeader() Create a blank query header.
QueryHeader(Node node) Create a query header from an XML node.
QueryHeader(String id, String title, String description, String type, String statusID, String securityType, String revisionNote, String dataDictID) Create a query header with the specified values.

Method Summary

Modifier and Type	Method and Description
Object	clone()
boolean	equals(Object rhs)
String	getDataDictID() Get the ID of the data dictionary used by this query.
String	getDescription() Get a string describing this query.
String	getID() Get the identification of this query.
String	getRevisionNote() Get a note about the revision history of this query.
String	getSecurityType() Get the type of security to apply to this query.
String	getStatusID() Get the status of the query.
String	getTitle() Get the title of this query.
String	getType() Get the type of the query, usually QUERY.
URI	getURIID() Get the identification of this query as a URI.
int	hashCode()
void	setDataDictID(String dataDictID) Set the ID of the data dictionary used by this query.
void	setDescription(String description) Set a string describing this query.
void	setID(String id) Set the identification of this query.
void	setRevisionNote(String revisionNote) Set a note about the revision history of this query.
void	setSecurityType(String securityType) Set the type of security to apply to this query.
void	setStatusID(String statusID) Set the status of the query.
void	setTitle(String title) Set the title of this query.
void	setType(String type) Set the type of the query, usually QUERY.
String	toString()
Node	toXML(Document doc) Document (aka serialize) this object into an XML DOM node.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryHeader

public QueryHeader()

Create a blank query header.

QueryHeader

public QueryHeader(String id,
                   String title,
                   String description,
                   String type,
                   String statusID,
                   String securityType,
                   String revisionNote,
                   String dataDictID)

Create a query header with the specified values.

Parameters:

id - The identification of this query.

title - The title of this query.

description - A string describing this query.

type - The type of the query, usually QUERY.

statusID - The status of the query.

securityType - The type of security to apply to this query.

revisionNote - A note about the revision history of this query.

dataDictID - The ID of the data dictionary used by this query.

QueryHeader

public QueryHeader(Node node)

Create a query header from an XML node.

Parameters:

node - The <queryAttributes> node.

Method Detail

getID

public String getID()

Get the identification of this query.

Returns:

The identification of this query.

getURIID

public URI getURIID()

Get the identification of this query as a URI.

Returns:

an URI value.

getTitle

public String getTitle()

Get the title of this query.

Returns:

The title of this query.

getDescription

public String getDescription()

Get a string describing this query.

Returns:

A string describing this query.

getType

public String getType()

Get the type of the query, usually QUERY.

Returns:

The type of the query, usually QUERY.

getStatusID

public String getStatusID()

Get the status of the query.

Returns:

The status of the query.

getSecurityType

public String getSecurityType()

Get the type of security to apply to this query.

Returns:

The type of security to apply to this query.

getRevisionNote

public String getRevisionNote()

Get a note about the revision history of this query.

Returns:

A note about the revision history of this query.

getDataDictID

public String getDataDictID()

Get the ID of the data dictionary used by this query.

Returns:

The ID of the data dictionary used by this query.

setID

public void setID(String id)

Set the identification of this query.

Parameters:

id - The identification of this query.

setTitle

public void setTitle(String title)

Set the title of this query.

Parameters:

title - The title of this query.

setDescription

public void setDescription(String description)

Set a string describing this query.

Parameters:

description - A string describing this query.

setType

public void setType(String type)

Set the type of the query, usually QUERY.

Parameters:

type - The type of the query, usually QUERY.

setStatusID

public void setStatusID(String statusID)

Set the status of the query.

Parameters:

statusID - The status of the query.

setSecurityType

public void setSecurityType(String securityType)

Set the type of security to apply to this query.

Parameters:

securityType - The type of security to apply to this query.

setRevisionNote

public void setRevisionNote(String revisionNote)

Set a note about the revision history of this query.

Parameters:

revisionNote - A note about the revision history of this query.

setDataDictID

public void setDataDictID(String dataDictID)

Set the ID of the data dictionary used by this query.

Parameters:

dataDictID - The ID of the data dictionary used by this query.

toXML

public Node toXML(Document doc)
           throws DOMException

Description copied from interface: Documentable

Document (aka serialize) this object into an XML DOM node.

Specified by:

toXML in interface Documentable

Parameters:

doc - What document will own the node.

Returns:

This object as an XML DOM node.

Throws:

DOMException - If an error occurs while creating the DOM structure.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object rhs)

Overrides:

equals in class Object

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object