thredds.catalog.parser.jdom
Class InvCatalogFactory10

java.lang.Object
  extended by thredds.catalog.parser.jdom.InvCatalogFactory10
All Implemented Interfaces:
InvCatalogConvertIF, MetadataConverterIF

public class InvCatalogFactory10
extends Object
implements InvCatalogConvertIF, MetadataConverterIF

Inventory Catalog parser, version 1.0. Reads InvCatalog.xml files, constructs object representation.

Author:
John Caron

Constructor Summary
InvCatalogFactory10()
           
 
Method Summary
 void addMetadataContent(org.jdom.Element mdataElement, Object contentObject)
          Serialize the InvMetadata content object to a org.jdom.Element and add ro the element.
 List<PathAliasReplacement> getDataRootLocationAliasExpanders()
           
protected  DateType makeDateType(String text, String format, String type)
           
 InvCatalogImpl parseXML(InvCatalogFactory fac, org.jdom.Document jdomDoc, URI uri)
          Create an InvCatalogImpl from a parsed document tree.
protected  InvAccessImpl readAccess(InvDatasetImpl dataset, org.jdom.Element accessElem)
           
protected  InvCatalogImpl readCatalog(org.jdom.Element catalogElem, URI docBaseURI)
           
protected  InvCatalogRef readCatalogRef(InvCatalogImpl cat, InvDatasetImpl parent, org.jdom.Element catRefElem, URI baseURI)
           
protected  ThreddsMetadata.Contributor readContributor(org.jdom.Element elem)
           
protected  ThreddsMetadata.Vocab readControlledVocabulary(org.jdom.Element elem)
           
protected  InvDatasetImpl readDataset(InvCatalogImpl catalog, InvDatasetImpl parent, org.jdom.Element dsElem, URI base)
           
protected  InvDatasetImpl readDatasetFmrc(InvCatalogImpl catalog, InvDatasetImpl parent, org.jdom.Element dsElem, URI base)
           
protected  void readDatasetInfo(InvCatalogImpl catalog, InvDatasetImpl dataset, org.jdom.Element dsElem, URI base)
           
protected  DataRootConfig readDatasetRoot(org.jdom.Element s)
           
protected  InvDatasetScan readDatasetScan(InvCatalogImpl catalog, InvDatasetImpl parent, org.jdom.Element dsElem, URI base)
           
protected  Map readDatasetScanAddProxies(org.jdom.Element addProxiesElem, org.jdom.Element addLatestElem, InvCatalogImpl catalog)
           
protected  DatasetEnhancer readDatasetScanAddTimeCoverage(org.jdom.Element addTimeCovElem)
           
protected  CrawlableDatasetLabeler readDatasetScanIdentifier(org.jdom.Element identifierElem)
           
protected  CrawlableDatasetLabeler readDatasetScanNamer(org.jdom.Element namerElem)
           
protected  InvDatasetScan readDatasetScanNew(InvCatalogImpl catalog, InvDatasetImpl parent, org.jdom.Element dsElem, URI base)
           
protected  CrawlableDatasetSorter readDatasetScanSorter(org.jdom.Element sorterElem)
           
protected  double readDataSize(org.jdom.Element parent)
           
protected  DateType readDate(org.jdom.Element elem)
           
protected  InvDocumentation readDocumentation(InvCatalog cat, org.jdom.Element s)
           
protected  double readDouble(org.jdom.Element elem)
           
protected  TimeDuration readDuration(org.jdom.Element elem)
           
protected  InvDatasetImpl readFeatureCollection(InvCatalogImpl catalog, InvDatasetImpl parent, org.jdom.Element dsElem, URI base)
           
protected  ThreddsMetadata.GeospatialCoverage readGeospatialCoverage(org.jdom.Element gcElem)
           
protected  ThreddsMetadata.Range readGeospatialRange(org.jdom.Element spElem, String defUnits)
           
protected  InvMetadata readMetadata(InvCatalog catalog, InvDatasetImpl dataset, org.jdom.Element mdataElement)
           
 Object readMetadataContent(InvDataset dataset, org.jdom.Element mdataElement)
          Create an InvMetadata content object from an org.jdom.Element.
 Object readMetadataContentFromURL(InvDataset dataset, URI uri)
          Create an InvMetadata content object from an XML document at a named URL.
protected  InvProperty readProperty(org.jdom.Element s)
           
protected  InvService readService(org.jdom.Element s, URI baseURI)
           
protected  ThreddsMetadata.Source readSource(org.jdom.Element elem)
           
protected  void readThreddsMetadata(InvCatalog catalog, InvDatasetImpl dataset, org.jdom.Element parent, ThreddsMetadata tmg)
           
protected  DateRange readTimeCoverage(org.jdom.Element tElem)
           
protected  ThreddsMetadata.Variable readVariable(org.jdom.Element varElem)
           
protected  ThreddsMetadata.Variables readVariables(InvCatalog cat, InvDataset ds, org.jdom.Element varsElem)
           
 void registerMetadataConverter(MetadataType type, MetadataConverterIF converter)
           
 void setDataRootLocationAliasExpanders(List<PathAliasReplacement> dataRootLocAliasExpanders)
           
 void setVersion(String version)
           
static void useBytesForDataSize(boolean b)
           
 boolean validateMetadataContent(Object contentObject, StringBuilder out)
          Validate internal data structures.
 org.jdom.Document writeCatalog(InvCatalogImpl cat)
           
protected  org.jdom.Element writeContributor(ThreddsMetadata.Contributor c)
           
protected  org.jdom.Element writeDate(String name, DateType date)
           
 org.jdom.Element writeGeospatialCoverage(ThreddsMetadata.GeospatialCoverage gc)
           
protected  void writeInheritedMetadata(org.jdom.Element elem, ThreddsMetadata tmi)
           
protected  org.jdom.Element writeSource(String elementName, ThreddsMetadata.Source p)
           
protected  void writeThreddsMetadata(org.jdom.Element elem, ThreddsMetadata tmg)
           
protected  org.jdom.Element writeTimeCoverage(DateRange t)
           
protected  org.jdom.Element writeVariable(ThreddsMetadata.Variable v)
           
protected  org.jdom.Element writeVariables(ThreddsMetadata.Variables vs)
           
 void writeXML(InvCatalogImpl catalog, OutputStream os)
          Write the catalog as an XML document to the specified stream.
 void writeXML(InvCatalogImpl catalog, OutputStream os, boolean raw)
          Write the catalog as an XML document to the specified stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InvCatalogFactory10

public InvCatalogFactory10()
Method Detail

useBytesForDataSize

public static void useBytesForDataSize(boolean b)

setDataRootLocationAliasExpanders

public void setDataRootLocationAliasExpanders(List<PathAliasReplacement> dataRootLocAliasExpanders)

getDataRootLocationAliasExpanders

public List<PathAliasReplacement> getDataRootLocationAliasExpanders()

parseXML

public InvCatalogImpl parseXML(InvCatalogFactory fac,
                               org.jdom.Document jdomDoc,
                               URI uri)
Description copied from interface: InvCatalogConvertIF
Create an InvCatalogImpl from a parsed document tree.

Specified by:
parseXML in interface InvCatalogConvertIF
Parameters:
fac - use this factory
jdomDoc - : a parsed document tree.
uri - : the URI for the document.
Returns:
an InvCatalog object

registerMetadataConverter

public void registerMetadataConverter(MetadataType type,
                                      MetadataConverterIF converter)

setVersion

public void setVersion(String version)

readAccess

protected InvAccessImpl readAccess(InvDatasetImpl dataset,
                                   org.jdom.Element accessElem)

readCatalog

protected InvCatalogImpl readCatalog(org.jdom.Element catalogElem,
                                     URI docBaseURI)

readCatalogRef

protected InvCatalogRef readCatalogRef(InvCatalogImpl cat,
                                       InvDatasetImpl parent,
                                       org.jdom.Element catRefElem,
                                       URI baseURI)

readContributor

protected ThreddsMetadata.Contributor readContributor(org.jdom.Element elem)

readControlledVocabulary

protected ThreddsMetadata.Vocab readControlledVocabulary(org.jdom.Element elem)

readDataset

protected InvDatasetImpl readDataset(InvCatalogImpl catalog,
                                     InvDatasetImpl parent,
                                     org.jdom.Element dsElem,
                                     URI base)

readDatasetInfo

protected void readDatasetInfo(InvCatalogImpl catalog,
                               InvDatasetImpl dataset,
                               org.jdom.Element dsElem,
                               URI base)

readFeatureCollection

protected InvDatasetImpl readFeatureCollection(InvCatalogImpl catalog,
                                               InvDatasetImpl parent,
                                               org.jdom.Element dsElem,
                                               URI base)

readDatasetFmrc

protected InvDatasetImpl readDatasetFmrc(InvCatalogImpl catalog,
                                         InvDatasetImpl parent,
                                         org.jdom.Element dsElem,
                                         URI base)

readDatasetScan

protected InvDatasetScan readDatasetScan(InvCatalogImpl catalog,
                                         InvDatasetImpl parent,
                                         org.jdom.Element dsElem,
                                         URI base)

readDatasetScanNew

protected InvDatasetScan readDatasetScanNew(InvCatalogImpl catalog,
                                            InvDatasetImpl parent,
                                            org.jdom.Element dsElem,
                                            URI base)

readDatasetScanIdentifier

protected CrawlableDatasetLabeler readDatasetScanIdentifier(org.jdom.Element identifierElem)

readDatasetScanNamer

protected CrawlableDatasetLabeler readDatasetScanNamer(org.jdom.Element namerElem)

readDatasetScanSorter

protected CrawlableDatasetSorter readDatasetScanSorter(org.jdom.Element sorterElem)

readDatasetScanAddProxies

protected Map readDatasetScanAddProxies(org.jdom.Element addProxiesElem,
                                        org.jdom.Element addLatestElem,
                                        InvCatalogImpl catalog)

readDatasetScanAddTimeCoverage

protected DatasetEnhancer readDatasetScanAddTimeCoverage(org.jdom.Element addTimeCovElem)

readDatasetRoot

protected DataRootConfig readDatasetRoot(org.jdom.Element s)

readDate

protected DateType readDate(org.jdom.Element elem)

makeDateType

protected DateType makeDateType(String text,
                                String format,
                                String type)

readDuration

protected TimeDuration readDuration(org.jdom.Element elem)

readDocumentation

protected InvDocumentation readDocumentation(InvCatalog cat,
                                             org.jdom.Element s)

readDouble

protected double readDouble(org.jdom.Element elem)

readGeospatialCoverage

protected ThreddsMetadata.GeospatialCoverage readGeospatialCoverage(org.jdom.Element gcElem)

readGeospatialRange

protected ThreddsMetadata.Range readGeospatialRange(org.jdom.Element spElem,
                                                    String defUnits)

readMetadata

protected InvMetadata readMetadata(InvCatalog catalog,
                                   InvDatasetImpl dataset,
                                   org.jdom.Element mdataElement)

readMetadataContent

public Object readMetadataContent(InvDataset dataset,
                                  org.jdom.Element mdataElement)
Description copied from interface: MetadataConverterIF
Create an InvMetadata content object from an org.jdom.Element.

Specified by:
readMetadataContent in interface MetadataConverterIF
Parameters:
dataset - : the containing dataset
mdataElement - : the element
Returns:
an object representing the metadata content. The type depends on the metadata handler.

readMetadataContentFromURL

public Object readMetadataContentFromURL(InvDataset dataset,
                                         URI uri)
                                  throws IOException
Description copied from interface: MetadataConverterIF
Create an InvMetadata content object from an XML document at a named URL.

Specified by:
readMetadataContentFromURL in interface MetadataConverterIF
Parameters:
dataset - : the containing dataset
uri - : the URI that the XML doc is at.
Returns:
an object representing the metadata content. The type depends on the metadata handler.
Throws:
IOException - on read error

validateMetadataContent

public boolean validateMetadataContent(Object contentObject,
                                       StringBuilder out)
Description copied from interface: MetadataConverterIF
Validate internal data structures.

Specified by:
validateMetadataContent in interface MetadataConverterIF
Parameters:
contentObject - : the content object
out - : print errors here
Returns:
true if no fatal validation errors.

addMetadataContent

public void addMetadataContent(org.jdom.Element mdataElement,
                               Object contentObject)
Description copied from interface: MetadataConverterIF
Serialize the InvMetadata content object to a org.jdom.Element and add ro the element.

Specified by:
addMetadataContent in interface MetadataConverterIF
Parameters:
mdataElement - : the org.w3c.dom.Element to add to
contentObject - : the InvMetadata content object

readProperty

protected InvProperty readProperty(org.jdom.Element s)

readSource

protected ThreddsMetadata.Source readSource(org.jdom.Element elem)

readService

protected InvService readService(org.jdom.Element s,
                                 URI baseURI)

readDataSize

protected double readDataSize(org.jdom.Element parent)

readTimeCoverage

protected DateRange readTimeCoverage(org.jdom.Element tElem)

readThreddsMetadata

protected void readThreddsMetadata(InvCatalog catalog,
                                   InvDatasetImpl dataset,
                                   org.jdom.Element parent,
                                   ThreddsMetadata tmg)

readVariable

protected ThreddsMetadata.Variable readVariable(org.jdom.Element varElem)

readVariables

protected ThreddsMetadata.Variables readVariables(InvCatalog cat,
                                                  InvDataset ds,
                                                  org.jdom.Element varsElem)

writeXML

public void writeXML(InvCatalogImpl catalog,
                     OutputStream os,
                     boolean raw)
              throws IOException
Write the catalog as an XML document to the specified stream.

Specified by:
writeXML in interface InvCatalogConvertIF
Parameters:
catalog - write this catalog
os - write to this OutputStream
raw - write raw file if true (for server configuration)
Throws:
IOException

writeXML

public void writeXML(InvCatalogImpl catalog,
                     OutputStream os)
              throws IOException
Write the catalog as an XML document to the specified stream.

Specified by:
writeXML in interface InvCatalogConvertIF
Parameters:
catalog - write this catalog
os - write to this OutputStream
Throws:
IOException

writeCatalog

public org.jdom.Document writeCatalog(InvCatalogImpl cat)

writeContributor

protected org.jdom.Element writeContributor(ThreddsMetadata.Contributor c)

writeDate

protected org.jdom.Element writeDate(String name,
                                     DateType date)

writeGeospatialCoverage

public org.jdom.Element writeGeospatialCoverage(ThreddsMetadata.GeospatialCoverage gc)

writeSource

protected org.jdom.Element writeSource(String elementName,
                                       ThreddsMetadata.Source p)

writeInheritedMetadata

protected void writeInheritedMetadata(org.jdom.Element elem,
                                      ThreddsMetadata tmi)

writeThreddsMetadata

protected void writeThreddsMetadata(org.jdom.Element elem,
                                    ThreddsMetadata tmg)

writeTimeCoverage

protected org.jdom.Element writeTimeCoverage(DateRange t)

writeVariable

protected org.jdom.Element writeVariable(ThreddsMetadata.Variable v)

writeVariables

protected org.jdom.Element writeVariables(ThreddsMetadata.Variables vs)


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.