org.restlet.service
Class MetadataService

java.lang.Object
  org.restlet.service.MetadataService

public class MetadataService
extends Object

Service providing access to metadata and their associated extension names.

Author:

Jerome Louvel (contact@noelios.com)

Constructor Summary

MetadataService()
Constructor.

Method Summary

void	addCommonExtensions() Adds a common list of associations from extensions to metadata.
void	addExtension(String extension, Metadata metadata) Maps an extension to some metadata (media type, language or character set) to an extension.
void	addExtension(String extension, Metadata metadata, boolean preferred) Maps an extension to some metadata (media type, language or character set) to an extension.
void	clearExtensions() clears the mappings for all extensions.
Encoding	getDefaultEncoding() Returns the default encoding for local representations.
Language	getDefaultLanguage() Returns the default language for local representations.
MediaType	getDefaultMediaType() Returns the default media type for local representations.
String	getExtension(Metadata metadata) Returns the first extension mapping to this metadata.
Map<String,Metadata>	getMappings() Deprecated. .
Metadata	getMetadata(String extension) Returns the metadata associated to this extension.
void	setDefaultEncoding(Encoding defaultEncoding) Sets the default encoding for local representations.
void	setDefaultLanguage(Language defaultLanguage) Sets the default language for local representations.
void	setDefaultMediaType(MediaType defaultMediaType) Sets the default media type for local representations.
void	setMappings(Map<String,Metadata> mappings) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataService

public MetadataService()

Constructor. Sets the default language to Language.ENGLISH_US, the default encoding to Encoding.IDENTITY (no encoding) and the default media type to MediaType.APPLICATION_OCTET_STREAM. It also calls the addCommonExtensions() method.

Method Detail

addCommonExtensions

public void addCommonExtensions()

Adds a common list of associations from extensions to metadata. The list of languages extensions:

• en: English
• es: Spanish
• fr: French

The list of media type extensions:

• ai: PostScript document
• atom: Atom syndication document
• au: AU audio file
• bin: Binary file
• bmp: Bitmap graphics
• class: Java bytecode
• css: CSS stylesheet
• dib: Device-Independent Bitmap Graphics
• doc: Microsoft Word document
• dtd: XML Document Type Definition
• eps: Encapsulated PostScript
• exe: Executable File (Microsoft Corporation)
• fmt: FreeMarker encoding
• gif: GIF image
• hqx: BinHex 4 Compressed Archive (Macintosh)
• htm, html: HTML document
• ico: Windows icon (Favicon)
• jad: Java Application Descriptor file
• jar: Java Archive
• java: Java source code
• jnlp: Java Web start launch file
• jpe, jpeg, jpg: JPEG image
• js: JavaScript document
• jsf: Java Server Faces file
• json: JavaScript Object Notation document
• kar: Karaoke MIDI file
• latex: LaTeX document
• man: Manual file
• mathml: Mathml XML document
• mid, midi: MIDI Audio
• mov, qt: QuickTime video clip (Apple Computer, Inc.)
• mp2, mp3: MPEG Audio Stream file
• mp4: MPEG-4 video file
• mpe, mpeg, mpg: MPEG video clip
• pdf: Adobe PDF document
• png: PNG image
• pps, ppt: Microsoft Powerpoint document
• ps: PostScript document
• rdf: Description Framework document
• rnc: Relax NG Schema document, Compact syntax
• rng: Relax NG Schema document, XML syntax
• rss: RSS file
• rtf: Rich Text Format document
• sit: StuffIt compressed archive file
• snd: Amiga sound
• svg: Scalable Vector Graphics file
• swf: Adobe Flash file
• tar: Tape Archive file
• tex: Tex file
• tif, tiff: Tagged Image Format File
• txt: Plain text
• ulw: MU-LAW (US telephony format)
• vm: Velocity encoding
• vrml: Virtual Reality Modeling Language file
• vxml: VoiceXML source file
• wadl: Web Application Description Language document
• wav: Waveform audio
• wrl: Plain text VRML file
• xht, xhtml: XHTML document
• xls: Microsoft Excel document
• xml: XML document
• xsd: W3C XML Schema document
• xslt: XSL Transform file
• xul: XML User Interface Language file
• z: UNIX compressed archive file
• zip: Zip archive

addExtension

public void addExtension(String extension,
                         Metadata metadata)

Maps an extension to some metadata (media type, language or character set) to an extension.

Parameters:

extension - The extension name.

metadata - The metadata to map.

addExtension

public void addExtension(String extension,
                         Metadata metadata,
                         boolean preferred)

Maps an extension to some metadata (media type, language or character set) to an extension.

Parameters:

extension - The extension name.

metadata - The metadata to map.

preferred - indicates if this mapping is the preferred one.

clearExtensions

public void clearExtensions()

clears the mappings for all extensions.

getDefaultEncoding

public Encoding getDefaultEncoding()

Returns the default encoding for local representations.

Returns:

The default encoding for local representations.

getDefaultLanguage

public Language getDefaultLanguage()

Returns the default language for local representations.

Returns:

The default language for local representations.

getDefaultMediaType

public MediaType getDefaultMediaType()

Returns the default media type for local representations.

Returns:

The default media type for local representations.

getExtension

public String getExtension(Metadata metadata)

Returns the first extension mapping to this metadata.

Parameters:

metadata - The metadata to find.

Returns:

The first extension mapping to this metadata.

getMappings

@Deprecated
public Map<String,Metadata> getMappings()

Deprecated. .

Returns the mappings from extension names to metadata. Creates a new instance if no one has been set. Note that this map is only a snapshot of the list of mappings.

Returns:

The mappings from extension names to metadata.

getMetadata

public Metadata getMetadata(String extension)

Returns the metadata associated to this extension. It returns null if the extension was not declared.

Parameters:

extension - The extension name without any delimiter.

Returns:

The metadata associated to this extension.

setDefaultEncoding

public void setDefaultEncoding(Encoding defaultEncoding)

Sets the default encoding for local representations.

Parameters:

defaultEncoding - The default encoding for local representations.

setDefaultLanguage

public void setDefaultLanguage(Language defaultLanguage)

Sets the default language for local representations.

Parameters:

defaultLanguage - The default language for local representations.

setDefaultMediaType

public void setDefaultMediaType(MediaType defaultMediaType)

Sets the default media type for local representations.

Parameters:

defaultMediaType - The default media type for local representations.

setMappings

@Deprecated
public void setMappings(Map<String,Metadata> mappings)

Deprecated.

Sets the mappings from extension names to metadata.

Parameters:

mappings - The mappings from extension names to metadata.