org.greenstone.gs3client.data
Class QueryFormData.QueryFormParam

java.lang.Object
  org.greenstone.gs3client.data.QueryFormData
      org.greenstone.gs3client.data.QueryFormData.QueryFormParam

Direct Known Subclasses:

QueryFormControl

Enclosing class:

QueryFormData

public static class QueryFormData.QueryFormParam
extends QueryFormData

Static inner class QueryFormParam is a subclass of QueryFormData and uniquely represents the data that can be contained in any <param> tag of the xml response that's returned when a describe request is sent to a Query Service. As such, a QueryFormParam can contain further QueryFormData (<param> or <option> elements) which are stored as subElements of this QueryFormParam.

Nested Class Summary

Nested classes/interfaces inherited from class org.greenstone.gs3client.data.QueryFormData

QueryFormData.QueryFormParam

Field Summary

java.lang.String	def default attribute of <param> tag
java.lang.String	ignore ignore attribute of <param> tag specifies whether this param will be ignored at ignore=pos
java.lang.String	occurs occurs attribute of <param> tag specifies how often the widget occurs
protected QueryFormData[]	subElements A <param> element in a Query response XML message can contain children that are <param> or <option>.
java.lang.String	type type attribute of <param> tag

Fields inherited from class org.greenstone.gs3client.data.QueryFormData

displayItem, name, OCCURS_ATT

Constructor Summary

QueryFormData.QueryFormParam(org.w3c.dom.Element param)
Constructor that creates a QueryFormParam object from the data contained in a <param>element of a Query response XML message.

Method Summary

QueryFormData[]	getSubElements() Read-only accessor for this QueryFormParam object's subElements
java.lang.String	show()

Methods inherited from class org.greenstone.gs3client.data.QueryFormData

extractDisplayItem, toString

Methods inherited from class java.lang.Object

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

Field Detail

type

public final java.lang.String type

type attribute of <param> tag

def

public final java.lang.String def

default attribute of <param> tag

occurs

public final java.lang.String occurs

occurs attribute of <param> tag specifies how often the widget occurs

ignore

public final java.lang.String ignore

ignore attribute of <param> tag specifies whether this param will be ignored at ignore=pos

subElements

protected QueryFormData[] subElements

A <param> element in a Query response XML message can contain children that are <param> or <option>. subElements therefore stores an array of QueryFormData to represent these. <param> CAN (need not) contain <options>s and/or more <param>s. If subElements is null, it obviously has no child <param>s.

Constructor Detail

QueryFormData.QueryFormParam

public QueryFormData.QueryFormParam(org.w3c.dom.Element param)

Constructor that creates a QueryFormParam object from the data contained in a <param>element of a Query response XML message.

Parameters:

param - is an entire <param>element - the one currently being processed.

Method Detail

getSubElements

public QueryFormData[] getSubElements()

Read-only accessor for this QueryFormParam object's subElements

Returns:

an array of this QueryFormParam's children QueryFormData objects (representing options or params). Null is returned if there are none.

show

public java.lang.String show()

Overrides:

show in class QueryFormData

Returns:

a display String of the member values of this QueryFormParam for debugging purposes