|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.service.Service
org.restlet.service.MetadataService
public class MetadataService
Application service providing access to metadata and their associated
extension names. The list of default mappings is documented in the
addCommonExtensions()
method.
Internally, the mappings are stored as a list of "extension, metadata" pairs.
Constructor Summary | |
---|---|
MetadataService()
Constructor. |
Method Summary | ||
---|---|---|
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 character set extensions: ascii: US-ASCII 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 csv: Comma-separated Values dat: Fixed-width Values dib: Device-Independent Bitmap Graphics doc: Microsoft Word document docx: Microsoft Office Word 2007 document docm: Office Word 2007 macro-enabled document dotx: Office Word 2007 template dotm: Office Word 2007 macro-enabled document template dtd: XML Document Type Definition eps: Encapsulated PostScript exe: Executable File (Microsoft Corporation) fmt: FreeMarker encoding form: Web forms (URL encoded) ftl: FreeMarker encoding gif: GIF image gwt: Java serialized object (using GWT-RPC encoder) 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 n3: RDF N3 document nt: RDF N-Triples document odb: OpenDocument Database odc: OpenDocument Chart odf: OpenDocument Formula odg: OpenDocument Drawing odi: OpenDocument Image odm: OpenDocument Master Document odp: OpenDocument Presentation ods: OpenDocument Spreadsheet odt: OpenDocument Text onetoc: Microsoft Office OneNote 2007 TOC onetoc2: Office OneNote 2007 TOC otg: OpenDocument Drawing Template oth: HTML Document Template otp: OpenDocument Presentation Template ots: OpenDocument Spreadsheet Template ott: OpenDocument Text Template oxt: OpenOffice.org extension pdf: Adobe PDF document png: PNG image potm: Office PowerPoint 2007 macro-enabled presentation template potx: Office PowerPoint 2007 template ppam: Office PowerPoint 2007 add-in pps, ppt: Microsoft Powerpoint document ppsm: Office PowerPoint 2007 macro-enabled slide show ppsx: Office PowerPoint 2007 slide show pptm: Office PowerPoint 2007 macro-enabled presentation pptx: Microsoft Office PowerPoint 2007 presentation 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 sav: SPSS Data sit: StuffIt compressed archive file sldm: Office PowerPoint 2007 macro-enabled slide sldx: Office PowerPoint 2007 slide snd: Amiga sound sps: SPSS Script Syntax sta: Stata data file svg: Scalable Vector Graphics file swf: Adobe Flash file tar: Tape Archive file tex: Tex file tif, tiff: Tagged Image Format File tsv: Tab-separated Values 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 xlam: Office Excel 2007 add-in xls: Microsoft Excel document xlsb: Office Excel 2007 binary workbook xlsm: Office Excel 2007 macro-enabled workbook xlsx: Microsoft Office Excel 2007 workbook xltm: Office Excel 2007 macro-enabled workbook template xltx: Office Excel 2007 template xmi: XMI document xml: XML document xsd: W3C XML Schema document xsl, xslt: XSL Transform file xul: XML User Interface Language file z: UNIX compressed archive file zip: Zip archive |
|
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. |
|
List<String> |
getAllCharacterSetExtensionNames()
Return the ordered list of extension names mapped to character set. |
|
List<CharacterSet> |
getAllCharacterSets(String extension)
Returns all the character sets associated to this extension. |
|
List<String> |
getAllEncodingExtensionNames()
Return the ordered list of extension names mapped to encodings. |
|
List<String> |
getAllExtensionNames()
Return the ordered list of extension names. |
|
List<String> |
getAllLanguageExtensionNames()
Return the ordered list of extension names mapped to languages. |
|
List<Language> |
getAllLanguages(String extension)
Returns all the languages associated to this extension. |
|
List<String> |
getAllMediaTypeExtensionNames()
Return the ordered list of extension names mapped to media types. |
|
List<MediaType> |
getAllMediaTypes(String extension)
Returns all the media types associated to this extension. |
|
List<Metadata> |
getAllMetadata(String extension)
Returns all the metadata associated to this extension. |
|
CharacterSet |
getCharacterSet(String extension)
Returns the character set associated to this extension. |
|
CharacterSet |
getDefaultCharacterSet()
Returns the default character set for textual representations. |
|
Encoding |
getDefaultEncoding()
Returns the default encoding for representations. |
|
Language |
getDefaultLanguage()
Returns the default language for representations. |
|
MediaType |
getDefaultMediaType()
Returns the default media type for representations. |
|
Encoding |
getEncoding(String extension)
Returns the encoding associated to this extension. |
|
String |
getExtension(Metadata metadata)
Returns the first extension mapping to this metadata. |
|
Language |
getLanguage(String extension)
Returns the language associated to this extension. |
|
MediaType |
getMediaType(String extension)
Returns the mediatype associated to this extension. |
|
Metadata |
getMetadata(String extension)
Returns the metadata associated to this extension. |
|
|
getMetadata(String extension,
Class<T> metadataType)
Returns the metadata associated to this extension. |
|
void |
setDefaultCharacterSet(CharacterSet defaultCharacterSet)
Sets the default character set for local representations. |
|
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. |
Methods inherited from class org.restlet.service.Service |
---|
createInboundFilter, createOutboundFilter, getContext, isEnabled, isStarted, isStopped, setContext, setEnabled, start, stop |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MetadataService()
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 |
---|
public void addCommonExtensions()
public void addExtension(String extension, Metadata metadata)
extension
- The extension name.metadata
- The metadata to map.public void addExtension(String extension, Metadata metadata, boolean preferred)
extension
- The extension name.metadata
- The metadata to map.preferred
- indicates if this mapping is the preferred one.public void clearExtensions()
public List<String> getAllCharacterSetExtensionNames()
public List<CharacterSet> getAllCharacterSets(String extension)
extension
- The extension name without any delimiter.
public List<String> getAllEncodingExtensionNames()
public List<String> getAllExtensionNames()
public List<String> getAllLanguageExtensionNames()
public List<Language> getAllLanguages(String extension)
extension
- The extension name without any delimiter.
public List<String> getAllMediaTypeExtensionNames()
public List<MediaType> getAllMediaTypes(String extension)
extension
- The extension name without any delimiter.
public List<Metadata> getAllMetadata(String extension)
extension
- The extension name without any delimiter.
public CharacterSet getCharacterSet(String extension)
extension
- The extension name without any delimiter.
public CharacterSet getDefaultCharacterSet()
public Encoding getDefaultEncoding()
public Language getDefaultLanguage()
public MediaType getDefaultMediaType()
public Encoding getEncoding(String extension)
extension
- The extension name without any delimiter.
public String getExtension(Metadata metadata)
metadata
- The metadata to find.
public Language getLanguage(String extension)
extension
- The extension name without any delimiter.
public MediaType getMediaType(String extension)
extension
- The extension name without any delimiter.
public Metadata getMetadata(String extension)
extension
- The extension name without any delimiter.
public <T extends Metadata> T getMetadata(String extension, Class<T> metadataType)
T
- extension
- The extension name without any delimiter.metadataType
- The target metadata type.
public void setDefaultCharacterSet(CharacterSet defaultCharacterSet)
defaultCharacterSet
- The default character set for local representations.public void setDefaultEncoding(Encoding defaultEncoding)
defaultEncoding
- The default encoding for local representations.public void setDefaultLanguage(Language defaultLanguage)
defaultLanguage
- The default language for local representations.public void setDefaultMediaType(MediaType defaultMediaType)
defaultMediaType
- The default media type for local representations.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |