org.opengis.cite.kml2.validation

Class LinkValidator

java.lang.Object

org.opengis.cite.kml2.validation.LinkValidator

public class LinkValidator
extends Object

Checks that the content of a kml:Link or kml:Icon element satisfies all applicable constraints. The relevant type definition is shown below.

 
 <xsd:complexType name="LinkType" final="#all">
   <xsd:complexContent>
     <xsd:extension base="kml:BasicLinkType">
       <xsd:all>
         <xsd:element ref="kml:abstractRefreshMode" minOccurs="0"/>
         <xsd:element ref="kml:refreshInterval" minOccurs="0"/>
         <xsd:element ref="kml:abstractViewRefreshMode" minOccurs="0"/>
         <xsd:element ref="kml:viewRefreshTime" minOccurs="0"/>
         <xsd:element ref="kml:viewBoundScale" minOccurs="0"/>
         <xsd:element ref="kml:viewFormat" minOccurs="0"/>
         <xsd:element ref="kml:httpQuery" minOccurs="0"/>
         <xsd:element ref="kml:LinkSimpleExtensionGroup" minOccurs="0"
           maxOccurs="unbounded"/>
         <xsd:element ref="kml:LinkObjectExtensionGroup" minOccurs="0"
           maxOccurs="unbounded"/>
       </xsd:all>
     </xsd:extension>
   </xsd:complexContent>
 </xsd:complexType>
 
 

Constructor Summary

Constructors

Constructor and Description
LinkValidator(int level, javax.ws.rs.core.MediaType... mediaTypes) Constructs a LinkValidator to check the constraints that apply to the specified conformance level.
LinkValidator(javax.ws.rs.core.MediaType... mediaTypes) Constructs a LinkValidator to check all mandatory constraints.

Method Summary

Modifier and Type	Method and Description
(package private) void	checkLinkConstraintsAtLevel2(Element link) Checks that all link constraints defined for CL2 are satisfied.
(package private) void	checkLinkProperties(Element link) Checks various properties that affect link processing.
(package private) void	checkLinkReferent(Element link) Checks that the link URI (href value) refers to an accessible resource whose content type is compatible with an acceptable media type.
String	getErrorMessages() Returns all error messages reported during the last call to isValid.
Iterator<org.opengis.cite.validation.ValidationError>	getErrors() Returns the errors reported during the last call to isValid.
boolean	isValid(Node node) Validates a link element by checking that: the URI it contains is accessible (using a HEAD request for 'http' URIs) the media type of the referenced resource is acceptable the values of various properties that affect link processing do not violate any constraints
void	reset() Resets the error handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkValidator

public LinkValidator(javax.ws.rs.core.MediaType... mediaTypes)

Constructs a LinkValidator to check all mandatory constraints.

Parameters:

mediaTypes - A collection of acceptable media types; if null or empty any type is acceptable.

LinkValidator

public LinkValidator(int level,
                     javax.ws.rs.core.MediaType... mediaTypes)

Constructs a LinkValidator to check the constraints that apply to the specified conformance level.

Parameters:

level - The applicable conformance level.

mediaTypes - A collection of acceptable media types; if null or empty any type is acceptable.

Method Detail

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 Iterator<org.opengis.cite.validation.ValidationError> getErrors()

Returns the errors reported during the last call to isValid.

Returns:

An iterator over the reported validation errors.

reset

public void reset()

Resets the error handler.

isValid

public boolean isValid(Node node)

Validates a link element by checking that:

1. the URI it contains is accessible (using a HEAD request for 'http' URIs)
2. the media type of the referenced resource is acceptable
3. the values of various properties that affect link processing do not violate any constraints

Parameters:

node - A kml:Link or kml:Icon element.

Returns:

true if the link is valid; false otherwise.

checkLinkReferent

void checkLinkReferent(Element link)

Checks that the link URI (href value) refers to an accessible resource whose content type is compatible with an acceptable media type. The resource is the target of a HEAD request; however if a 403 (Forbidden) status code is received because the request was rejected, a GET request will then be attempted.

If the URI contains tile parameters (for a large image), the single tile at level 0 will be requested. That is, all tile parameters are replaced with 0.

Parameters:

link - An Element representing a link (of type kml:LinkType).

See Also:

"OGC KML 2.3 - Abstract Test Suite, ATC-139: Link reference"

checkLinkProperties

void checkLinkProperties(Element link)

Checks various properties that affect link processing.

Parameters:

link - An Element representing a link (of type kml:LinkType).

See Also:

"OGC 14-068, ATC-109: Link properties"

checkLinkConstraintsAtLevel2

void checkLinkConstraintsAtLevel2(Element link)

Checks that all link constraints defined for CL2 are satisfied. The applicable test cases are listed below.

• ATC-205: viewFormat element not empty
• ATC-206: httpQuery element not empty
• ATC-210: Link refresh mode

Parameters:

link - An Element representing a link (of type kml:LinkType).