org.opengis.cite.kml2.validation

Class RegionValidator

java.lang.Object

org.opengis.cite.kml2.validation.RegionValidator

public class RegionValidator
extends Object

The relevant type definition is shown below (with extension points omitted); the spatial extent of the region must be specified using a kml:LatLonAltBox element.

 
 <xsd:complexType name="RegionType" final="#all">
   <xsd:complexContent>
     <xsd:extension base="kml:AbstractObjectType">
       <xsd:all>
         <element ref="kml:AbstractExtentGroup" minOccurs="0"/>
         <element ref="kml:Lod" minOccurs="0"/>
       </xsd:all>
     </xsd:extension>
   </xsd:complexContent>
 </xsd:complexType>
 
 

The applicable test cases are listed below.

• ATC-138: Region visibility (LOD)
• ATC-140: Region

Constructor Summary

Constructors

Constructor and Description
RegionValidator() Default constructor.
RegionValidator(int level) Constructs a RegionValidator to check the constraints that apply to the specified conformance level.

Method Summary

Modifier and Type	Method and Description
(package private) void	checkLodFadeRange(Element region) Checks that the following expression holds for the pixel ramp values that determine whether or not a region is active:
(package private) void	checkRegionExtent(Element region) Checks the spatial extent of a Region (kml:LatLonAltBox).
(package private) void	checkRegionVisibility(Element region) Checks that the properties of the kml:Lod element satisfy the following constraints: it contains the kml:minLodPixels element kml:minLodPixels < kml:maxLodPixels (Note: -1 denotes positive infinity)
String	getErrorMessages() Returns the error messages reported during the last call to validateRegionExtent.
(package private) double	getLodParameterValue(Element region, String paramName) Gets the value of a Lod parameter.
boolean	isValid(Node node) Validates a kml:Region element.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionValidator

public RegionValidator()

Default constructor.

RegionValidator

public RegionValidator(int level)

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

Parameters:

level - The applicable conformance level.

Method Detail

getErrorMessages

public String getErrorMessages()

Returns the error messages reported during the last call to validateRegionExtent.

Returns:

A String containing error messages (may be empty).

isValid

public boolean isValid(Node node)

Validates a kml:Region element.

Parameters:

node - A kml:Region element.

Returns:

true if the region satisfies all applicable constraints; false otherwise.

checkRegionExtent

void checkRegionExtent(Element region)

Checks the spatial extent of a Region (kml:LatLonAltBox). The default extent of a region spans the entire surface of the EGM96 geoid.

Parameters:

region - A kml:Region element.

checkRegionVisibility

void checkRegionVisibility(Element region)

Checks that the properties of the kml:Lod element satisfy the following constraints:

1. it contains the kml:minLodPixels element
2. kml:minLodPixels < kml:maxLodPixels (Note: -1 denotes positive infinity)

Parameters:

region - A kml:Region element.

See Also:

"OGC KML 2.3 - Abstract Test Suite, ATC-138: Region visibility (LOD)"

checkLodFadeRange

void checkLodFadeRange(Element region)

Checks that the following expression holds for the pixel ramp values that determine whether or not a region is active:

 
 kml:minFadeExtent + kml:maxFadeExtent <= kml:maxLodPixels - kml:minLodPixels
 
 

Parameters:

region - a kml:Region element.

See Also:

"OGC KML 2.3 - Abstract Test Suite, ATC-306: LOD fade range"

getLodParameterValue

double getLodParameterValue(Element region,
                            String paramName)

Gets the value of a Lod parameter.

Parameters:

region - A kml:Region element.

paramName - The (local) name of some Lod parameter.

Returns:

The actual value of the parameter (or its specified default value).