Package nl.b3p.csw.client

Class Output

java.lang.Object

nl.b3p.csw.client.Output

All Implemented Interfaces:

Iterable<org.jdom2.Element>

Direct Known Subclasses:

OutputById, OutputBySearch

public abstract class Output
extends Object
implements Iterable<org.jdom2.Element>

Author:

Erik van de Pol

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.jdom2.xpath.XPath	abstractJdomXPath
protected static org.jdom2.xpath.XPath	browseGraphicFileName
protected static org.jdom2.Namespace	cswNameSpace
protected static org.jdom2.Namespace	cswPrefixNameSpace
protected static org.jdom2.xpath.XPath	dateStampJdomXPath
protected static org.jdom2.xpath.XPath	dateTimeStampJdomXPath
protected static List<Protocol>	defaultAllowedProtocols
protected static Protocol	defaultProtocol
protected static String	exceptionName
protected static org.jdom2.filter.ElementFilter	fileIdentifierElementFilter
protected static org.jdom2.Namespace	gcoNameSpace
protected static org.jdom2.Namespace	gcoPrefixNameSpace
protected static org.jdom2.Namespace	gmdNameSpace
protected static org.jdom2.Namespace	gmdPrefixNameSpace
protected static org.jdom2.xpath.XPath	identificationDateJdomXPath
static String	ISO_19115
static String	ISO_19119
protected static org.jdom2.xpath.XPath	keywordsJdomXPath
protected static org.apache.commons.logging.Log	log
protected static org.jdom2.xpath.XPath	metadataStandardNameXPath
protected static org.jdom2.xpath.XPath	operatesOnXpath
protected static org.jdom2.filter.ElementFilter	resourceElementFilter
protected javax.xml.bind.JAXBElement	response
protected static org.jdom2.xpath.XPath	responsibleOrganisationNameJdomXPath
protected static org.jdom2.filter.ElementFilter	resultElementFilter
protected Schema	schema
protected static org.jdom2.Namespace	srvPrefixNameSpace
protected static org.jdom2.xpath.XPath	titleJdomXPath
protected static org.jdom2.xpath.XPath	urlDatasetNameXPath
protected org.jdom2.Document	xmlDocument

Constructor Summary

Constructors

Constructor	Description
Output(org.jdom2.Document xmlDocument)
Output(org.jdom2.Document xmlDocument, Schema schema)

Method Summary

Modifier and Type	Method	Description
String	getAbstractText(org.jdom2.Element recordElement)
String	getBrowseGraphicFileName(org.jdom2.Element recordElement)
String	getDateStamp(org.jdom2.Element recordElement)	First try to get the Date object if empty or ommitted try to get the DateTime object.
String	getIdentificationDate(org.jdom2.Element recordElement)
List<org.jdom2.Text>	getKeyWords(org.jdom2.Element recordElement)
List<String>	getKeyWordsAsStringList(org.jdom2.Element recordElement)
String	getMetadataStandardName(org.jdom2.Element recordElement)	Returns the metadata standard name.
List<OperatesOn>	getOperatesOn(org.jdom2.Element recordElement)
List<Map<String,String>>	getOperatesOnAsStringList(org.jdom2.Element recordElement)
List<OnlineResource>	getResourcesFlattened()	List of OnlineResource's.
List<OnlineResource>	getResourcesFlattened(List<Protocol> allowedProtocols)	List of OnlineResource's.
Map<URI,List<OnlineResource>>	getResourcesMap()	List of OnlineResource's grouped by URI.
Map<URI,List<OnlineResource>>	getResourcesMap(List<Protocol> allowedProtocols)	List of OnlineResource's grouped by URI.
Map<URI,List<OnlineResource>>	getResourcesMap(org.jdom2.Element resultElem, List<Protocol> allowedProtocols)
protected javax.xml.bind.JAXBElement	getResponse()
String	getResponsibleOrganisationName(org.jdom2.Element recordElement)
List<org.jdom2.Element>	getSearchResults()
String	getSearchResultsString()
abstract List<Element>	getSearchResultsW3C()
protected abstract Class	getTargetType()
String	getTitle(org.jdom2.Element recordElement)
org.jdom2.Document	getTransformedXml(String transformPath)
List<UrlDataset>	getUrlDatasets(org.jdom2.Element recordElement)
List<Map<String,String>>	getUrlDatasetsAsStringList(org.jdom2.Element recordElement)
String	getUUID(org.jdom2.Element rootElement)
String	getUUID(org.jdom2.Element rootElement, boolean sanitize)
org.jdom2.Document	getXml()
boolean	isMetadataForService(org.jdom2.Element recordElement)	Returns true if given metadata element describes a service.
Iterator<org.jdom2.Element>	iterator()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

log

protected static final org.apache.commons.logging.Log log

cswNameSpace

protected static final org.jdom2.Namespace cswNameSpace

gmdNameSpace

protected static final org.jdom2.Namespace gmdNameSpace

gcoNameSpace

protected static final org.jdom2.Namespace gcoNameSpace

cswPrefixNameSpace

protected static final org.jdom2.Namespace cswPrefixNameSpace

gmdPrefixNameSpace

protected static final org.jdom2.Namespace gmdPrefixNameSpace

gcoPrefixNameSpace

protected static final org.jdom2.Namespace gcoPrefixNameSpace

srvPrefixNameSpace

protected static final org.jdom2.Namespace srvPrefixNameSpace

resultElementFilter

protected static final org.jdom2.filter.ElementFilter resultElementFilter

resourceElementFilter

protected static final org.jdom2.filter.ElementFilter resourceElementFilter

fileIdentifierElementFilter

protected static final org.jdom2.filter.ElementFilter fileIdentifierElementFilter

titleJdomXPath

protected static org.jdom2.xpath.XPath titleJdomXPath

keywordsJdomXPath

protected static org.jdom2.xpath.XPath keywordsJdomXPath

identificationDateJdomXPath

protected static org.jdom2.xpath.XPath identificationDateJdomXPath

responsibleOrganisationNameJdomXPath

protected static org.jdom2.xpath.XPath responsibleOrganisationNameJdomXPath

dateStampJdomXPath

protected static org.jdom2.xpath.XPath dateStampJdomXPath

dateTimeStampJdomXPath

protected static org.jdom2.xpath.XPath dateTimeStampJdomXPath

abstractJdomXPath

protected static org.jdom2.xpath.XPath abstractJdomXPath

browseGraphicFileName

protected static org.jdom2.xpath.XPath browseGraphicFileName

metadataStandardNameXPath

protected static org.jdom2.xpath.XPath metadataStandardNameXPath

urlDatasetNameXPath

protected static org.jdom2.xpath.XPath urlDatasetNameXPath

operatesOnXpath

protected static org.jdom2.xpath.XPath operatesOnXpath

defaultProtocol

protected static final Protocol defaultProtocol

defaultAllowedProtocols

protected static final List<Protocol> defaultAllowedProtocols

exceptionName

protected static final String exceptionName

See Also:

Constant Field Values

ISO_19115

public static final String ISO_19115

See Also:

Constant Field Values

ISO_19119

public static final String ISO_19119

See Also:

Constant Field Values

xmlDocument

protected org.jdom2.Document xmlDocument

response

protected javax.xml.bind.JAXBElement response

schema

protected Schema schema

Constructor Detail

Output

public Output(org.jdom2.Document xmlDocument)

Output

public Output(org.jdom2.Document xmlDocument,
              Schema schema)

Method Detail

getXml

public org.jdom2.Document getXml()

getTransformedXml

public org.jdom2.Document getTransformedXml(String transformPath)
                                     throws TransformerException

Throws:

TransformerException

getResponse

protected javax.xml.bind.JAXBElement getResponse()
                                          throws org.jdom2.JDOMException,
                                                 javax.xml.bind.JAXBException,
                                                 OwsException

Throws:

org.jdom2.JDOMException

javax.xml.bind.JAXBException

OwsException

getTargetType

protected abstract Class getTargetType()

iterator

public Iterator<org.jdom2.Element> iterator()

Specified by:

iterator in interface Iterable<org.jdom2.Element>

getSearchResultsW3C

public abstract List<Element> getSearchResultsW3C()
                                           throws org.jdom2.JDOMException,
                                                  javax.xml.bind.JAXBException,
                                                  OwsException

Throws:

org.jdom2.JDOMException

javax.xml.bind.JAXBException

OwsException

getSearchResults

public List<org.jdom2.Element> getSearchResults()
                                         throws org.jdom2.JDOMException,
                                                javax.xml.bind.JAXBException,
                                                OwsException

Throws:

org.jdom2.JDOMException

javax.xml.bind.JAXBException

OwsException

getSearchResultsString

public String getSearchResultsString()
                              throws org.jdom2.JDOMException,
                                     javax.xml.bind.JAXBException,
                                     IOException,
                                     OwsException

Throws:

org.jdom2.JDOMException

javax.xml.bind.JAXBException

IOException

OwsException

getResourcesFlattened

public List<OnlineResource> getResourcesFlattened()

List of OnlineResource's. If the same resource-URL is included in more result-metadata, all are included in this list.

Returns:

List of OnlineResource's.

getResourcesFlattened

public List<OnlineResource> getResourcesFlattened(List<Protocol> allowedProtocols)

List of OnlineResource's. If the same resource-URL is included in more result-metadata, all are included in this list.

Parameters:

allowedProtocols - Online resource protocols that are allowed in the search results. An empty list indicates all Protocol's are allowed.

Returns:

List of OnlineResource's.

getResourcesMap

public Map<URI,List<OnlineResource>> getResourcesMap()

List of OnlineResource's grouped by URI.

Returns:

List of OnlineResource's grouped by URI.

getResourcesMap

public Map<URI,List<OnlineResource>> getResourcesMap(List<Protocol> allowedProtocols)

List of OnlineResource's grouped by URI.

Parameters:

allowedProtocols - Online resource protocols that are allowed in the search results. An empty list indicates all Protocol's are allowed.

Returns:

List of OnlineResource's grouped by URI.

getResourcesMap

public Map<URI,List<OnlineResource>> getResourcesMap(org.jdom2.Element resultElem,
                                                           List<Protocol> allowedProtocols)
                                                    throws UnsupportedOperationException

Throws:

UnsupportedOperationException

getUUID

public String getUUID(org.jdom2.Element rootElement)
               throws UnsupportedOperationException

Throws:

UnsupportedOperationException

getUUID

public String getUUID(org.jdom2.Element rootElement,
                      boolean sanitize)
               throws UnsupportedOperationException

Throws:

UnsupportedOperationException

getTitle

public String getTitle(org.jdom2.Element recordElement)
                throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getKeyWords

public List<org.jdom2.Text> getKeyWords(org.jdom2.Element recordElement)
                                 throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getKeyWordsAsStringList

public List<String> getKeyWordsAsStringList(org.jdom2.Element recordElement)
                                     throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getIdentificationDate

public String getIdentificationDate(org.jdom2.Element recordElement)
                             throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getResponsibleOrganisationName

public String getResponsibleOrganisationName(org.jdom2.Element recordElement)
                                      throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getDateStamp

public String getDateStamp(org.jdom2.Element recordElement)
                    throws org.jdom2.JDOMException

First try to get the Date object if empty or ommitted try to get the DateTime object.

Throws:

org.jdom2.JDOMException

getAbstractText

public String getAbstractText(org.jdom2.Element recordElement)
                       throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getBrowseGraphicFileName

public String getBrowseGraphicFileName(org.jdom2.Element recordElement)
                                throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getMetadataStandardName

public String getMetadataStandardName(org.jdom2.Element recordElement)
                               throws org.jdom2.JDOMException

Returns the metadata standard name.

Parameters:

recordElement -

Returns:

The ISO verison of the metadata standard

Throws:

org.jdom2.JDOMException

isMetadataForService

public boolean isMetadataForService(org.jdom2.Element recordElement)
                             throws org.jdom2.JDOMException

Returns true if given metadata element describes a service.

Parameters:

recordElement -

Returns:

true if metadata describes services

Throws:

org.jdom2.JDOMException

getOperatesOn

public List<OperatesOn> getOperatesOn(org.jdom2.Element recordElement)
                               throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getOperatesOnAsStringList

public List<Map<String,String>> getOperatesOnAsStringList(org.jdom2.Element recordElement)
                                                         throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getUrlDatasets

public List<UrlDataset> getUrlDatasets(org.jdom2.Element recordElement)
                                throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException

getUrlDatasetsAsStringList

public List<Map<String,String>> getUrlDatasetsAsStringList(org.jdom2.Element recordElement)
                                                          throws org.jdom2.JDOMException

Throws:

org.jdom2.JDOMException