nl.b3p.ogc.wfs.v110

Class DescribeFeatureTypeType

java.lang.Object

nl.b3p.ogc.wfs.v110.BaseRequestType

nl.b3p.ogc.wfs.v110.DescribeFeatureTypeType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DescribeFeatureType

public class DescribeFeatureTypeType
extends BaseRequestType
implements Serializable

The DescribeFeatureType operation allows a client application to request that a Web Feature Service describe one or more feature types. A Web Feature Service must be able to generate feature descriptions as valid GML3 application schemas. The schemas generated by the DescribeFeatureType operation can be used by a client application to validate the output. Feature instances within the WFS interface must be specified using GML3. The schema of feature instances specified within the WFS interface must validate against the feature schemas generated by the DescribeFeatureType request.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeFeatureTypeType()

Method Summary

Methods

Modifier and Type	Method and Description
void	addTypeName(int index, String vTypeName) Method addTypeName
void	addTypeName(String vTypeName) Method addTypeName
void	clearTypeName() Method clearTypeName
Enumeration	enumerateTypeName() Method enumerateTypeName
String	getOutputFormat() Returns the value of field 'outputFormat'.
String[]	getTypeName() Method getTypeName
String	getTypeName(int index) Method getTypeName
int	getTypeNameCount() Method getTypeNameCount
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
boolean	removeTypeName(String vTypeName) Method removeTypeName
void	setOutputFormat(String outputFormat) Sets the value of field 'outputFormat'.
void	setTypeName(int index, String vTypeName) Method setTypeName
void	setTypeName(String[] typeNameArray) Method setTypeName
static BaseRequestType	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class nl.b3p.ogc.wfs.v110.BaseRequestType

getHandle, getService, getVersion, setHandle, setService, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeFeatureTypeType

public DescribeFeatureTypeType()

Method Detail

addTypeName

public void addTypeName(String vTypeName)
                 throws IndexOutOfBoundsException

Method addTypeName

Parameters:

vTypeName -

Throws:

IndexOutOfBoundsException

addTypeName

public void addTypeName(int index,
               String vTypeName)
                 throws IndexOutOfBoundsException

Method addTypeName

Parameters:

index -

vTypeName -

Throws:

IndexOutOfBoundsException

clearTypeName

public void clearTypeName()

Method clearTypeName

enumerateTypeName

public Enumeration enumerateTypeName()

Method enumerateTypeName

Returns:

Enumeration

getOutputFormat

public String getOutputFormat()

Returns the value of field 'outputFormat'. The field 'outputFormat' has the following description: The outputFormat attribute is used to specify what schema description language should be used to describe features. The default value of 'text/xml; subtype=3.1.1' means that the WFS must generate a GML3 application schema that can be used to validate the GML3 output of a GetFeature request or feature instances specified in Transaction operations. For the purposes of experimentation, vendor extension, or even extensions that serve a specific community of interest, other acceptable output format values may be advertised by a WFS service in the capabilities document. The meaning of such values in not defined in the WFS specification. The only proviso is such cases is that clients may safely ignore outputFormat values that do not recognize.

Returns:

String

getTypeName

public String getTypeName(int index)
                   throws IndexOutOfBoundsException

Method getTypeName

Parameters:

index -

Returns:

String

Throws:

IndexOutOfBoundsException

getTypeName

public String[] getTypeName()

Method getTypeName

Returns:

String

getTypeNameCount

public int getTypeNameCount()

Method getTypeNameCount

Returns:

int

isValid

public boolean isValid()

Method isValid

Overrides:

isValid in class BaseRequestType

Returns:

boolean

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeTypeName

public boolean removeTypeName(String vTypeName)

Method removeTypeName

Parameters:

vTypeName -

Returns:

boolean

setOutputFormat

public void setOutputFormat(String outputFormat)

Sets the value of field 'outputFormat'. The field 'outputFormat' has the following description: The outputFormat attribute is used to specify what schema description language should be used to describe features. The default value of 'text/xml; subtype=3.1.1' means that the WFS must generate a GML3 application schema that can be used to validate the GML3 output of a GetFeature request or feature instances specified in Transaction operations. For the purposes of experimentation, vendor extension, or even extensions that serve a specific community of interest, other acceptable output format values may be advertised by a WFS service in the capabilities document. The meaning of such values in not defined in the WFS specification. The only proviso is such cases is that clients may safely ignore outputFormat values that do not recognize.

Parameters:

outputFormat - the value of field 'outputFormat'.

setTypeName

public void setTypeName(int index,
               String vTypeName)
                 throws IndexOutOfBoundsException

Method setTypeName

Parameters:

index -

vTypeName -

Throws:

IndexOutOfBoundsException

setTypeName

public void setTypeName(String[] typeNameArray)

Method setTypeName

Parameters:

typeNameArray -

unmarshal

public static BaseRequestType unmarshal(Reader reader)
                                 throws org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Returns:

BaseRequestType

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Overrides:

validate in class BaseRequestType

Throws:

org.exolab.castor.xml.ValidationException