Package io.gdcc.spi.export

Interface XMLExporter

All Superinterfaces:

Exporter, Plugin

public interface XMLExporter
extends Exporter

XML Exporter is an extension of the base Exporter interface that adds the additional methods needed for generating XML metadata export formats.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	API_LEVEL

Method Summary

Modifier and Type	Method	Description
default String	getMediaType()	To support effective downloads of metadata in this Exporter's format, the Exporter should specify an appropriate mime type.
String	getXMLNameSpace()
String	getXMLSchemaLocation()
String	getXMLSchemaVersion()

Methods inherited from interface io.gdcc.spi.export.Exporter

exportDataset, getDisplayName, getFormatName, getPrerequisiteFormatName, identity, isAvailableToUsers, isHarvestable

Field Details

API_LEVEL

static final int API_LEVEL

See Also:

• Constant Field Values

Method Details

getXMLNameSpace

String getXMLNameSpace()

Returns:

- the name space of the XML schema

Implementation Note:

for the ddi exporter, this method returns "ddi:codebook:2_5"

getXMLSchemaLocation

String getXMLSchemaLocation()

Returns:

- the location of the XML schema as a String (must be a valid URI)

API Note:

According to the XML specification, the value must be a URI

Implementation Note:

for the ddi exporter, this method returns "https://ddialliance.org/Specification/DDI-Codebook/2.5/XMLSchema/codebook.xsd"

getXMLSchemaVersion

String getXMLSchemaVersion()

Returns:

- the version of the XML schema

Implementation Note:

for the ddi exporter, this method returns "2.5"

getMediaType

default String getMediaType()

Description copied from interface: Exporter

To support effective downloads of metadata in this Exporter's format, the Exporter should specify an appropriate mime type.

Specified by:

getMediaType in interface Exporter

Returns:

- should always be MediaType.APPLICATION_XML