org.nodal.filesystem
Interface DocumentFormat

All Known Implementing Classes:

DirectorySchema, DocumentFormat.AutoRegister

public interface DocumentFormat

A description of a Document type.

Nested Class Summary

static class	DocumentFormat.AutoRegister
static interface	DocumentFormat.Decoder The class that describes DocumentFormat decoders.
static interface	DocumentFormat.Encoder The class that describes DocumentFormat encoders.
static class	DocumentFormat.Registry A class for managing the registration of DocumentSchemas via their MIME type designators.

Method Summary

DocumentFormat.Decoder	decoder() A decoder that will translate an InputStream into a Node graph.
DocumentFormat.Encoder	encoder() An encoder that will translate a Node graph into an OutputStream.
java.lang.String	mimeType() The MIME type record used to index this schema.
NodeType	rootType() The Type of the root node of the document graph for a document of this type.

Method Detail

mimeType

public java.lang.String mimeType()

The MIME type record used to index this schema.

rootType

public NodeType rootType()

The Type of the root node of the document graph for a document of this type.

encoder

public DocumentFormat.Encoder encoder()

An encoder that will translate a Node graph into an OutputStream.

decoder

public DocumentFormat.Decoder decoder()

A decoder that will translate an InputStream into a Node graph.