loci.ome.editor

Class TemplateParser

java.lang.Object

loci.ome.editor.TemplateParser

public class TemplateParser
extends Object

A simple xml parser to help set up the MetadataEditor's gui based on the commonly used data specified in Template.xml

Source code:

Trac, Gitweb

Author:

Christopher Peterson crpeterson2 at wisc.edu

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentBuilderFactory	DOC_FACT Factory for generating document builders.
static String[]	OLD_DEF_LIST A list of regular (non "home-baked") type defs to cruise.
protected Element	root The root xml Element in the Document.
protected Element[]	tabList Holds a list of the tabs necessary gathered from Template.xml.
protected Document	templateDoc Document generated by the DOM's parse.
static String	TYPE_DEF_FOLDER The filename of the folder the semantic type defs are in.
static String[]	TYPE_DEF_LIST A list of filenames where semantic type defs are found.

Constructor Summary

Constructors

Constructor and Description
TemplateParser(String filename) Parses the template document designated by the file argument, creating a list of "top-level" Elements which I define as those elements that have either an OMENode as a parent or a CustomAttributesNode as a parent that has an OMENode as a parent these top-level elements correspond to the tabs formed in the MetadataPane

Method Summary

Methods

Modifier and Type	Method and Description
static Hashtable	getRefHash() Returns a hashtable to store the types associated with a reference element will be implemented as a Hashtable of Hashtables first key corresponds to the OMEElement, second (nested) key corresponds to OMEAttribute, and finally the value corresponds to what type the OMEAttribute should have.
Element	getRoot()
Element[]	getTabs() Returns an array of Elements representing the tabs in the editor.
String	getVersion() Returns the version information from the template.
static void	main(String[] args) Used for debugging.

Methods inherited from class java.lang.Object

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

Field Detail

DOC_FACT

public static final DocumentBuilderFactory DOC_FACT

Factory for generating document builders.

TYPE_DEF_LIST

public static final String[] TYPE_DEF_LIST

A list of filenames where semantic type defs are found.

OLD_DEF_LIST

public static final String[] OLD_DEF_LIST

A list of regular (non "home-baked") type defs to cruise.

TYPE_DEF_FOLDER

public static final String TYPE_DEF_FOLDER

The filename of the folder the semantic type defs are in.

See Also:

Constant Field Values

tabList

protected Element[] tabList

Holds a list of the tabs necessary gathered from Template.xml.

templateDoc

protected Document templateDoc

Document generated by the DOM's parse.

root

protected Element root

The root xml Element in the Document.

Constructor Detail

TemplateParser

public TemplateParser(String filename)

Parses the template document designated by the file argument, creating a list of "top-level" Elements which I define as those elements that have either an OMENode as a parent or a CustomAttributesNode as a parent that has an OMENode as a parent these top-level elements correspond to the tabs formed in the MetadataPane

Method Detail

getRoot

public Element getRoot()

getTabs

public Element[] getTabs()

Returns an array of Elements representing the tabs in the editor.

getRefHash

public static Hashtable getRefHash()

Returns a hashtable to store the types associated with a reference element will be implemented as a Hashtable of Hashtables first key corresponds to the OMEElement, second (nested) key corresponds to OMEAttribute, and finally the value corresponds to what type the OMEAttribute should have.

getVersion

public String getVersion()

Returns the version information from the template.

main

public static void main(String[] args)

Used for debugging.