deegree 2.5 (2011/06/29 09:44 build-8-official)

org.deegree.ogcwebservices.csw.discovery
Class GetRecordsDocument

java.lang.Object
  extended by org.deegree.framework.xml.XMLFragment
      extended by org.deegree.ogcbase.OGCDocument
          extended by org.deegree.ogcwebservices.csw.AbstractCSWRequestDocument
              extended by org.deegree.ogcwebservices.csw.discovery.GetRecordsDocument
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
GetRecordsDocument_2_0_2

public class GetRecordsDocument
extends AbstractCSWRequestDocument

Represents an XML GetRecords document of an OGC CSW 2.0.0 and 2.0.1 compliant service.

Version:
$Revision: 9307 $, $Date: 2007-12-21 08:37:43 +0100 (Fr, 21 Dez 2007) $
Author:
Torsten Friebe , Markus Schneider , last edited by: $Author: apoth $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.deegree.ogcbase.OGCDocument
GMLNS
 
Fields inherited from class org.deegree.framework.xml.XMLFragment
DEFAULT_URL, nsContext, XLNNS
 
Constructor Summary
GetRecordsDocument()
           
 
Method Summary
protected  void checkReferencedVariables(ComplexFilter constraint, java.util.Map<java.lang.String,QualifiedName> variables)
          Iterates over the Operations of a complexfilter to find if non declared variables are used.
(package private)  void createEmptyDocument()
           
protected  void findNonDeclaredVariables(AbstractOperation operation, java.util.Map<java.lang.String,QualifiedName> variables)
          (Recursively) finds a reference to a non declared variable in the propertyname of the given operation.
protected  void findNonDeclaredVariables(PropertyName propName, java.util.Map<java.lang.String,QualifiedName> variables)
          Parse the string representation of the the propertyname to find a variable reference to a non declared Variable.
 void findVariablesInTypeName(java.lang.String typeName, org.w3c.dom.Node queryNode, java.util.List<QualifiedName> typeNames, java.util.Map<java.lang.String,QualifiedName> variables, boolean bindTypeNameToNS)
          Helper method to find any declared variables in given Query/@typeNames
protected  boolean isEbrimDefined(org.w3c.dom.Node contextNode)
           
 GetRecords parse(java.lang.String id)
          Extracts a GetRecords representation of this object.
 QualifiedName parseQNameFromString(java.lang.String typeName, org.w3c.dom.Node queryNode, boolean bindTypeNameToNS)
           
 
Methods inherited from class org.deegree.ogcwebservices.csw.AbstractCSWRequestDocument
parseDRMParams
 
Methods inherited from class org.deegree.ogcbase.OGCDocument
parseCodeList, parseCodeListArray, parseExtendedPropertyPath, parseInterval, parseKeywords, parseKeywords, parseLonLatEnvelope, parseOnLineResource, parsePropertyPath, parseTimePeriod, parseTimePeriods, parseTimePositions, parseTimeSequence, parseTypedLiteral, parseValues
 
Methods inherited from class org.deegree.framework.xml.XMLFragment
getAsPrettyString, getAsString, getAttachedSchemas, getQualifiedName, getRootElement, getSystemId, hasSchema, load, load, load, parseQualifiedName, parseSimpleLink, prettyPrint, prettyPrint, resolve, setRootElement, setSystemId, setSystemId, toString, write, write, write, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GetRecordsDocument

public GetRecordsDocument()
Method Detail

parse

public GetRecords parse(java.lang.String id)
                 throws OGCWebServiceException
Extracts a GetRecords representation of this object.

Parameters:
id - unique ID of the request
Returns:
GetRecords representation of this object
Throws:
MissingParameterValueException
InvalidParameterValueException
OperationNotSupportedException - if an CqlText constrained is requested
OGCWebServiceException - if something else went wrong

isEbrimDefined

protected boolean isEbrimDefined(org.w3c.dom.Node contextNode)
Parameters:
contextNode -
Returns:
true if the namespace "urn:oasis:names:tc:ebxml- regrep:xsd:rim:3.0" was found in one of the nodes of the dom-tree.

findVariablesInTypeName

public void findVariablesInTypeName(java.lang.String typeName,
                                    org.w3c.dom.Node queryNode,
                                    java.util.List<QualifiedName> typeNames,
                                    java.util.Map<java.lang.String,QualifiedName> variables,
                                    boolean bindTypeNameToNS)
                             throws OGCWebServiceException,
                                    java.net.URISyntaxException
Helper method to find any declared variables in given Query/@typeNames

Parameters:
typeName - the type name to test
queryNode - the querynode (used to find a given prefix)
typeNames - a list to save the typeName (as QualifiedNames) in
variables - a Map containing the vars/QualifiedName mappings
bindTypeNameToNS - if the namespaces should be bounded to the typeNames
Throws:
java.net.URISyntaxException - if the prefix is not bound to a namespace
OGCWebServiceException - if a variable name is unambiguous

parseQNameFromString

public QualifiedName parseQNameFromString(java.lang.String typeName,
                                          org.w3c.dom.Node queryNode,
                                          boolean bindTypeNameToNS)
                                   throws java.net.URISyntaxException
Parameters:
typeName - to be transformed to a QName
queryNode - needed to get the namespace
bindTypeNameToNS - if true the namespace will be bound to the qualified name
Returns:
a QualifiedName representing the typeName
Throws:
java.net.URISyntaxException

checkReferencedVariables

protected void checkReferencedVariables(ComplexFilter constraint,
                                        java.util.Map<java.lang.String,QualifiedName> variables)
                                 throws OGCWebServiceException
Iterates over the Operations of a complexfilter to find if non declared variables are used.

Parameters:
constraint -
variables -
Throws:
OGCWebServiceException

findNonDeclaredVariables

protected void findNonDeclaredVariables(AbstractOperation operation,
                                        java.util.Map<java.lang.String,QualifiedName> variables)
                                 throws OGCWebServiceException
(Recursively) finds a reference to a non declared variable in the propertyname of the given operation.

Parameters:
operation - to be checked
variables - which were declared
Throws:
OGCWebServiceException - if such a reference is found

findNonDeclaredVariables

protected void findNonDeclaredVariables(PropertyName propName,
                                        java.util.Map<java.lang.String,QualifiedName> variables)
                                 throws OGCWebServiceException
Parse the string representation of the the propertyname to find a variable reference to a non declared Variable.

Parameters:
propName - to check
variables - which were declared
Throws:
InvalidParameterValueException - if such a reference was found.
OGCWebServiceException

createEmptyDocument

void createEmptyDocument()
                   throws java.io.IOException,
                          org.xml.sax.SAXException
Throws:
java.io.IOException
org.xml.sax.SAXException

deegree 2.5 (2011/06/29 09:44 build-8-official)

an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://www.deegree.org