org.sdmxsource.sdmx.api.model.format

Interface StructureFormat

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

SdmxStructureFormat

public interface StructureFormat
extends java.io.Serializable

StructureFormat is an Interface which wrappers a strongly typed and non-extensible STRUCTURE_OUTPUT_FORMAT enumeration. The purpose of the wrapper is to allow for additional implementations to be provided which may describe non-sdmx formats which are not supported by the STRUCTURE_OUTPUT_FORMAT enum.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFormatAsString() Returns a string representation of the format, that can be used for auditing and debugging purposes.
STRUCTURE_OUTPUT_FORMAT	getSdmxOutputFormat() Returns the SDMX Structure Output Type that this interface is describing.

Method Detail

getSdmxOutputFormat

STRUCTURE_OUTPUT_FORMAT getSdmxOutputFormat()

Returns the SDMX Structure Output Type that this interface is describing.

If this is not describing an SDMX message then this will return null and the implementation class will be expected to expose additional methods to describe the output format

Returns:

sdmx output format, or null if this is not describing an SDMX output

getFormatAsString

java.lang.String getFormatAsString()

Returns a string representation of the format, that can be used for auditing and debugging purposes.

This is expected to return a not null response.

Returns: