org.opengis.cite.kml2.validation

Class SchemaChecker

java.lang.Object

org.opengis.cite.kml2.validation.SchemaChecker

public class SchemaChecker
extends Object

Checks constraints to apply to kml:Schema elements. The relevant type definition is shown below (with extension points omitted).

 
 <xsd:complexType name="SchemaType" final="#all">
   <xsd:all>
 	   <xsd:element ref="kml:SimpleField" minOccurs="0" maxOccurs="unbounded"/>
 	   <xsd:element ref="kml:SimpleArrayField" minOccurs="0" maxOccurs="unbounded"/>
 	   <xsd:element ref="kml:SchemaExtension" minOccurs="0" maxOccurs="unbounded"/>
 	 </xsd:all>
   <xsd:attribute name="name" type="string"/>
 	 <xsd:attribute name="id" type="ID"/>
   <xsd:anyAttribute namespace="##other" processContents="lax"/>
 </xsd:complexType>
 
 

The applicable test cases are identified below:

• ATC-125: Schema identifier
• ATC-126: SimpleField definition

See Also:

"OGC KML 2.3, 9.11: kml:SimpleField"

Field Summary

Fields

Modifier and Type	Field and Description
(package private) List<String>	commonPrefixes List of common prefix symbols in UCUM ('c','k', 'M', ..).
(package private) org.opengis.cite.validation.ValidationErrorHandler	errHandler
(package private) URL	uomCodeListRef

Constructor Summary

Constructors

Constructor and Description
SchemaChecker() Default constructor.

Method Summary

Modifier and Type	Method and Description
(package private) void	checkDataType(Element simpleField) Checks that the value of the 'type' attribute is a known (simple) datatype.
(package private) void	checkSimpleArrayFields(Element schema) Checks that a kml:SimpleArrayField element satisfies all applicable constraints.
(package private) void	checkSimpleFields(Element schema) Checks that a kml:SimpleField element satisfies all applicable constraints.
void	checkUnitOfMeasure(Element schemaField) Checks that a definition exists for a given unit of measure reference.
String	getErrorMessages() Returns all error messages reported during the last call to isValid.
List<org.opengis.cite.validation.ValidationError>	getErrors() Returns all errors reported to the handler.
(package private) List<String>	getUomPrefixes()
boolean	isValid(Node node) Validates a kml:Schema element.

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

uomCodeListRef

URL uomCodeListRef

commonPrefixes

List<String> commonPrefixes

List of common prefix symbols in UCUM ('c','k', 'M', ..).

Constructor Detail

SchemaChecker

public SchemaChecker()

Default constructor.

Method Detail

getUomPrefixes

List<String> getUomPrefixes()

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).

getErrors

public List<org.opengis.cite.validation.ValidationError> getErrors()

Returns all errors reported to the handler.

Returns:

A list containing error descriptions (may be empty).

isValid

public boolean isValid(Node node)

Validates a kml:Schema element.

Parameters:

node - A kml:Schema element.

Returns:

true if the schema is valid; false otherwise.

checkSimpleFields

void checkSimpleFields(Element schema)

Checks that a kml:SimpleField element satisfies all applicable constraints.

Parameters:

schema - A kml:Schema element.

checkSimpleArrayFields

void checkSimpleArrayFields(Element schema)

Checks that a kml:SimpleArrayField element satisfies all applicable constraints.

Parameters:

schema - A kml:Schema element.

checkDataType

void checkDataType(Element simpleField)

Checks that the value of the 'type' attribute is a known (simple) datatype. Any of the primitive or derived datatypes defined in XML Schema (Part 2) are acceptable.

Note: While a simple datatype that is derived from an XML Schema datatype is also allowed, such a user-defined datatype is not currently verified and will be reported as an error.

Parameters:

simpleField - A kml:SimpleField element.

See Also:

"OGC KML 2.3, 9.11.4.1: kml:SimpleField - type", W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes

checkUnitOfMeasure

public void checkUnitOfMeasure(Element schemaField)

Checks that a definition exists for a given unit of measure reference. If the reference is an absolute URI, the definition must exist but the format is irrelevant. Otherwise the reference must correspond to a code in the Unified Code for Units of Measure (UCUM). Prefix symbols may be used (e.g. 'km' for kilometre, 'ha' for hectare).

Parameters:

schemaField - A kml:SimpleField or kml:SimpleArrayField element.

See Also:

Unified Code for Units of Measure