thredds.catalog

Interface MetadataConverterIF

All Known Implementing Classes:

CatGenConfigMetadataFactory, InvCatalogFactory10

public interface MetadataConverterIF

Converts JDOM Element to Objects holding metadata content.

Author:

John Caron

See Also:

InvCatalogConvertIF, InvCatalogFactory

Method Summary

Methods

Modifier and Type	Method and Description
void	addMetadataContent(org.jdom.Element mdataElement, java.lang.Object contentObject) Serialize the InvMetadata content object to a org.jdom.Element and add ro the element.
java.lang.Object	readMetadataContent(InvDataset dataset, org.jdom.Element mdataElement) Create an InvMetadata content object from an org.jdom.Element.
java.lang.Object	readMetadataContentFromURL(InvDataset dataset, java.net.URI uri) Create an InvMetadata content object from an XML document at a named URL.
boolean	validateMetadataContent(java.lang.Object contentObject, java.lang.StringBuilder out) Validate internal data structures.

Method Detail

readMetadataContent

java.lang.Object readMetadataContent(InvDataset dataset,
                                   org.jdom.Element mdataElement)

Create an InvMetadata content object from an org.jdom.Element.

Parameters:

dataset - : the containing dataset

mdataElement - : the element

Returns:

an object representing the metadata content. The type depends on the metadata handler.

readMetadataContentFromURL

java.lang.Object readMetadataContentFromURL(InvDataset dataset,
                                          java.net.URI uri)
                                            throws java.io.IOException

Create an InvMetadata content object from an XML document at a named URL.

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:

java.io.IOException - on read error

addMetadataContent

void addMetadataContent(org.jdom.Element mdataElement,
                      java.lang.Object contentObject)

Serialize the InvMetadata content object to a org.jdom.Element and add ro the element.

Parameters:

mdataElement - : the org.w3c.dom.Element to add to

contentObject - : the InvMetadata content object

validateMetadataContent

boolean validateMetadataContent(java.lang.Object contentObject,
                              java.lang.StringBuilder out)

Validate internal data structures.

Parameters:

contentObject - : the content object

out - : print errors here

Returns:

true if no fatal validation errors.