CMLDictionary

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> xmlcml >> cml >> [ metadata overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.xmlcml.cml.metadata.CMLDictionary

SOURCE |

Download org.xmlcml.cml.metadata.CMLDictionary

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.xmlcml.cml.metadata
Interface CMLDictionary

public interface CMLDictionary

Method Summary

void addEntry(CMLDictionaryEntry entry)
          add entry to dictionary

CMLDictionaryEntry[] getEntries()
          get all entries in dictionary;

CMLDictionaryEntry getEntryById(java.lang.String id)
          get an entry in dictionary by ID;

CMLDictionaryEntry getEntryByName(java.lang.String title)
          get all entry in dictionary by title/name;

java.lang.String getName()
          get name for dictionary.

java.lang.String getNamespaceURI()
          get namespaceURI for dictionary.

java.lang.String getPrefix()
          get prefix for dictionary.

void parse(java.net.URL url)
          reads a dictionary;

void setNamespace(java.lang.String prefix, java.lang.String namespaceURI)
          set prefix and namespaceURI for dictionary.

Method Detail

parse

public void parse(java.net.URL url)
           throws java.io.IOException,
                  org.xmlcml.cml.CMLException

reads a dictionary;

getEntries

public CMLDictionaryEntry[] getEntries()

get all entries in dictionary;

getEntryById

public CMLDictionaryEntry getEntryById(java.lang.String id)

get an entry in dictionary by ID;

getEntryByName

public CMLDictionaryEntry getEntryByName(java.lang.String title)

get all entry in dictionary by title/name;

addEntry

public void addEntry(CMLDictionaryEntry entry)
              throws org.xmlcml.cml.CMLException

add entry to dictionary

getName

public java.lang.String getName()

get name for dictionary.

setNamespace

public void setNamespace(java.lang.String prefix,
                         java.lang.String namespaceURI)

set prefix and namespaceURI for dictionary. Example "cml" and "http://www.xml-cml.org/dict". This can be used to generate an xmlns attribute on the data instance

getPrefix

public java.lang.String getPrefix()

get prefix for dictionary.

getNamespaceURI

public java.lang.String getNamespaceURI()

get namespaceURI for dictionary.