CommonFixture (CityGML 2.0 Conformance Test Suite 0.2 API)

java.lang.Object
- org.opengis.cite.citygml20.CommonFixture

Direct Known Subclasses:

AppearanceModuleValidation, BridgeModuleValidation, BuildingModuleValidation, CityFurnitureModuleValidation, CityObjectGroupModuleValidation, CoreModuleValidation, CoreValidation, GenericsModuleValidation, LandUseModuleValidation, MandatoryRequirementsValidation, ReliefModuleValidation, TransportationModuleValidation, TunnelModuleValidation, VegetationModuleValidation, WaterBodyModuleValidation
```
public class CommonFixture
extends Object
```
A supporting base class that sets up a common test fixture. These configuration methods are invoked before those defined in a subclass.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.sun.jersey.api.client.Client`	`client` HTTP client component (JAX-RS Client API).
`protected static String`	`REFINTERGRITY_SCH` Define XSD path
`protected com.sun.jersey.api.client.ClientRequest`	`request` An HTTP request message.
`protected com.sun.jersey.api.client.ClientResponse`	`response` An HTTP response message.
`static String`	`ROOT_PKG_PATH` Root test suite package (absolute path).
`protected Document`	`testSubject`
`protected static String`	`XSD_APPEARANCE`
`protected static String`	`XSD_BRIDGE`
`protected static String`	`XSD_BUILDING`
`protected static String`	`XSD_CITYFURNITURE`
`protected static String`	`XSD_CITYGMLCORE`
`protected static String`	`XSD_CITYOBJECTGROUP`
`protected static String`	`XSD_GENERICS`
`protected static String`	`XSD_LANDUSE`
`protected static String`	`XSD_RELIF`
`protected static String`	`XSD_TRANSPORTATION`
`protected static String`	`XSD_TUNNEL`
`protected static String`	`XSD_VEGETATION`
`protected static String`	`XSD_WATERBODY`

Constructor Summary

Constructors
Constructor and Description

CommonFixture()

Constructors
Constructor and Description
`CommonFixture()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.sun.jersey.api.client.ClientRequest`	`buildGetRequest(URI endpoint, Map<String,String> qryParams, javax.ws.rs.core.MediaType... mediaTypes)` Builds an HTTP request message that uses the GET method.
`void`	`clearMessages()`
`Document`	`getResponseEntityAsDocument(com.sun.jersey.api.client.ClientResponse response, String targetURI)` Obtains the (XML) response entity as a DOM Document.
`protected ArrayList<String>`	`GetToValidateXsdPathArrayList(Document doc)`
`void`	`initCommonFixture(org.testng.ITestContext testContext)` Initializes the common test fixture with a client component for interacting with HTTP endpoints.
`boolean`	`isMultipleXMLSchemaValid(String xmlString, String[] arrXsdPath)` Description: Identify that a XML document is valid with XSD Template or not
`String`	`TransformXMLDocumentToXMLString(Document xmlDoc)` Transform XML Document to UTF-8 String

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ROOT_PKG_PATH
```
public static final String ROOT_PKG_PATH
```
    Root test suite package (absolute path).
    
    See Also:
    
    Constant Field Values
  - client
```
protected com.sun.jersey.api.client.Client client
```
    HTTP client component (JAX-RS Client API).
  - request
```
protected com.sun.jersey.api.client.ClientRequest request
```
    An HTTP request message.
  - response
```
protected com.sun.jersey.api.client.ClientResponse response
```
    An HTTP response message.
  - testSubject
```
protected Document testSubject
```
  - REFINTERGRITY_SCH
```
protected static final String REFINTERGRITY_SCH
```
    Define XSD path
    
    See Also:
    
    Constant Field Values
  - XSD_APPEARANCE
```
protected static final String XSD_APPEARANCE
```
    See Also:
    
    Constant Field Values
  - XSD_BRIDGE
```
protected static final String XSD_BRIDGE
```
    See Also:
    
    Constant Field Values
  - XSD_BUILDING
```
protected static final String XSD_BUILDING
```
    See Also:
    
    Constant Field Values
  - XSD_CITYFURNITURE
```
protected static final String XSD_CITYFURNITURE
```
    See Also:
    
    Constant Field Values
  - XSD_CITYGMLCORE
```
protected static final String XSD_CITYGMLCORE
```
    See Also:
    
    Constant Field Values
  - XSD_CITYOBJECTGROUP
```
protected static final String XSD_CITYOBJECTGROUP
```
    See Also:
    
    Constant Field Values
  - XSD_GENERICS
```
protected static final String XSD_GENERICS
```
    See Also:
    
    Constant Field Values
  - XSD_LANDUSE
```
protected static final String XSD_LANDUSE
```
    See Also:
    
    Constant Field Values
  - XSD_RELIF
```
protected static final String XSD_RELIF
```
    See Also:
    
    Constant Field Values
  - XSD_TRANSPORTATION
```
protected static final String XSD_TRANSPORTATION
```
    See Also:
    
    Constant Field Values
  - XSD_TUNNEL
```
protected static final String XSD_TUNNEL
```
    See Also:
    
    Constant Field Values
  - XSD_VEGETATION
```
protected static final String XSD_VEGETATION
```
    See Also:
    
    Constant Field Values
  - XSD_WATERBODY
```
protected static final String XSD_WATERBODY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CommonFixture
```
public CommonFixture()
```
- Method Detail
  - initCommonFixture
```
public void initCommonFixture(org.testng.ITestContext testContext)
```
    Initializes the common test fixture with a client component for interacting with HTTP endpoints.
    
    Parameters:
    
    testContext - The test context that contains all the information for a test run, including suite attributes.
  - clearMessages
```
public void clearMessages()
```
  - getResponseEntityAsDocument
```
public Document getResponseEntityAsDocument(com.sun.jersey.api.client.ClientResponse response,
                                            String targetURI)
```
    Obtains the (XML) response entity as a DOM Document. This convenience method wraps a static method call to facilitate unit testing (Mockito workaround).
    
    Parameters:
    
    response - A representation of an HTTP response message.
    
    targetURI - The target URI from which the entity was retrieved (may be null).
    
    Returns:
    
    A Document representing the entity.
    
    See Also:
    
    ClientUtils.getResponseEntityAsDocument(com.sun.jersey.api.client.ClientResponse, java.lang.String)
  - buildGetRequest
```
public com.sun.jersey.api.client.ClientRequest buildGetRequest(URI endpoint,
                                                               Map<String,String> qryParams,
                                                               javax.ws.rs.core.MediaType... mediaTypes)
```
    Builds an HTTP request message that uses the GET method. This convenience method wraps a static method call to facilitate unit testing (Mockito workaround).
    
    Parameters:
    
    endpoint - A URI indicating the target resource.
    
    qryParams - A Map containing query parameters (may be null);
    
    mediaTypes - A list of acceptable media types; if not specified, generic XML ("application/xml") is preferred.
    
    Returns:
    
    A ClientRequest object.
    
    See Also:
    
    ClientUtils.buildGetRequest(java.net.URI, java.util.Map<java.lang.String, java.lang.String>, javax.ws.rs.core.MediaType...)
  - TransformXMLDocumentToXMLString
```
public String TransformXMLDocumentToXMLString(Document xmlDoc)
                                       throws Exception
```
    Transform XML Document to UTF-8 String
    
    Parameters:
    
    xmlDoc - The XML Document
    
    Returns:
    
    A String data type of XML Document
    
    Throws:
    
    Exception - TransformerConfigurationException, TransformerException
  - isMultipleXMLSchemaValid
```
public boolean isMultipleXMLSchemaValid(String xmlString,
                                        String[] arrXsdPath)
```
    Description: Identify that a XML document is valid with XSD Template or not
    
    Parameters:
    
    xmlString - The XML String
    
    arrXsdPath - A String Array of XSD Path
    
    Returns:
    
    A boolean value indicates whether the XML document is valid with XSD Template or not
  - GetToValidateXsdPathArrayList
```
protected ArrayList<String> GetToValidateXsdPathArrayList(Document doc)
```

Class CommonFixture

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROOT_PKG_PATH

client

request

response

testSubject

REFINTERGRITY_SCH

XSD_APPEARANCE

XSD_BRIDGE

XSD_BUILDING

XSD_CITYFURNITURE

XSD_CITYGMLCORE

XSD_CITYOBJECTGROUP

XSD_GENERICS

XSD_LANDUSE

XSD_RELIF

XSD_TRANSPORTATION

XSD_TUNNEL

XSD_VEGETATION

XSD_WATERBODY

Constructor Detail

CommonFixture

Method Detail

initCommonFixture

clearMessages

getResponseEntityAsDocument

buildGetRequest

TransformXMLDocumentToXMLString

isMultipleXMLSchemaValid

GetToValidateXsdPathArrayList