org.opengis.cite.kml2.validation

Class ExtendedDataValidator

java.lang.Object

org.opengis.cite.kml2.validation.ExtendedDataValidator

public class ExtendedDataValidator
extends Object

Checks constraints to apply to kml:ExtendedData elements. The relevant type definition is shown below.

 
 <xsd:complexType name="ExtendedDataType" final="#all">
   <xsd:all>
 	   <xsd:element ref="kml:Data" minOccurs="0" maxOccurs="unbounded"/>
 	   <xsd:element ref="kml:SchemaData" minOccurs="0" maxOccurs="unbounded"/>
 	   <xsd:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
   </xsd:all>
  <xsd:anyAttribute namespace="##other" processContents="lax"/>
 </xsd:complexType>
 
 

The applicable test cases are listed below.

• ATC-128
• ATC-233

Field Summary

Fields

Modifier and Type	Field and Description
(package private) org.opengis.cite.validation.ValidationErrorHandler	errHandler
(package private) Document	ownerDocument
(package private) SchemaChecker	schemaChecker

Constructor Summary

Constructors

Constructor and Description
ExtendedDataValidator() Default constructor.

Method Summary

Modifier and Type	Method and Description
(package private) void	checkData(Element extData) Checks that a kml:Data element (an untyped name-value pair) satisfies all applicable constraints.
(package private) void	checkSchemaData(Element extData) Checks that a kml:SchemaData element satisfies all applicable constraints: the 'schemaUrl' attribute value is a URL (it may be an absolute URI) with a fragment component that refers to a kml:Schema element; all kml:SimpleData child elements have a 'name' attribute that matches the name of a declared kml:SimpleField element in the associated kml:Schema element (see ATC-126); the values of all kml:SimpleData child elements conform to their declared types.
(package private) net.sf.saxon.s9api.XdmNode	fetchSchema(URI schemaURI) Fetches the kml:Schema element referenced by the given URI.
(package private) String[]	getDataValues(Element data) Gets the values supplied by the given schema data element.
String	getErrorMessages() Returns all error messages reported during the last call to isValid.
boolean	isValid(Node node) Validates a kml:ExtendedData element.
(package private) void	setOwnerDocument(Document doc) Intended to facilitate unit testing only.
(package private) void	validateSchemaData(Element schemaData, Map<String,net.sf.saxon.s9api.ItemType> schemaFields) Validates the content of a kml:SchemaData element against the associated custom schema.

Methods inherited from class java.lang.Object

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

Field Detail

errHandler

org.opengis.cite.validation.ValidationErrorHandler errHandler

schemaChecker

SchemaChecker schemaChecker

ownerDocument

Document ownerDocument

Constructor Detail

ExtendedDataValidator

public ExtendedDataValidator()

Default constructor.

Method Detail

setOwnerDocument

void setOwnerDocument(Document doc)

Intended to facilitate unit testing only.

Parameters:

doc - The document containing the custom data.

getErrorMessages

public String getErrorMessages()

Returns all error messages reported during the last call to isValid.

Returns:

A String containing the reported error messages (may be empty).

isValid

public boolean isValid(Node node)

Validates a kml:ExtendedData element.

Parameters:

node - A kml:ExtendedData element.

Returns:

true if the extended data elements are valid; false otherwise.

checkData

void checkData(Element extData)

Checks that a kml:Data element (an untyped name-value pair) satisfies all applicable constraints.

1. the value of the 'name' attribute is unique within the context of the parent kml:ExtendedData element
2. if present, the uom attribute identifies a valid unit of measurement

Parameters:

extData - A kml:ExtendedData element.

See Also:

"OGC KML 2.3 – Abstract Test Suite, ATC-128: Data element has distinct name", "OGC KML 2.3 – Abstract Test Suite, ATC-233: Valid unit of measurement"

checkSchemaData

void checkSchemaData(Element extData)

Checks that a kml:SchemaData element satisfies all applicable constraints:

1. the 'schemaUrl' attribute value is a URL (it may be an absolute URI) with a fragment component that refers to a kml:Schema element;
2. all kml:SimpleData child elements have a 'name' attribute that matches the name of a declared kml:SimpleField element in the associated kml:Schema element (see ATC-126);
3. the values of all kml:SimpleData child elements conform to their declared types.

Parameters:

extData - A kml:ExtendedData element.

See Also:

"OGC KML 2.3 - Abstract Test Suite, ATC-127: SchemaData content"

validateSchemaData

void validateSchemaData(Element schemaData,
                        Map<String,net.sf.saxon.s9api.ItemType> schemaFields)

Validates the content of a kml:SchemaData element against the associated custom schema. In particular, for each data element:

1. it has a 'name' attribute that matches the name of a declared field in the associated schema;
2. all values conform to the declared type.

Parameters:

schemaData - A kml:SchemaData element containing kml:SimpleData or kml:SimpleArrayData elements.

schemaFields - A Map containing information (name, type) about the fields declared in the custom schema.

getDataValues

String[] getDataValues(Element data)

Gets the values supplied by the given schema data element.

Parameters:

data - A kml:SimpleData or kml:SimpleArrayData element.

Returns:

An array of strings containing the data value(s).

fetchSchema

net.sf.saxon.s9api.XdmNode fetchSchema(URI schemaURI)
                                throws net.sf.saxon.s9api.SaxonApiException,
                                       RuntimeException

Fetches the kml:Schema element referenced by the given URI. A relative URI is expected to be a same-document reference.

Parameters:

schemaURI - A URI containing a fragment identifier that refers to a kml:Schema element.

Returns:

An XdmNode representing a kml:Schema element.

Throws:

net.sf.saxon.s9api.SaxonApiException - If an error occurs while trying to retrieve the target resource.

RuntimeException - If a matching kml:Schema element cannot be obtained.