loci.ome.notes

Class Template

java.lang.Object

loci.ome.notes.Template

public class Template
extends Object

Loads a template from a file, and stores the options associated with this template. See template-format.txt for details of how to construct a valid template file.

Source code:

Trac, Gitweb

Constructor Summary

Constructors

Constructor and Description
Template(File file) Constructs a new Template from the given file.
Template(InputStream stream) Constructs a new Template from the given InputStream.
Template(String file) Constructs a new Template from the given filename.
Template(TemplateTab[] tabs, Hashtable options) Constructs a new Template from TemplateTabs and a list of options.

Method Summary

Methods

Modifier and Type	Method and Description
void	changeValue(String key, String value) Change the value of an option.
boolean	editMapping() Returns true if we can edit the OME-CA mapping on-the-fly.
boolean	editTemplateFields() Returns true if we can edit this template on-the-fly.
int[]	getBackgroundColor() Get the background color defined by this template.
int	getDefaultHeight() Get the default window height defined by this template.
int	getDefaultWidth() Get the default window width defined by this template.
int[]	getFontColor() Get the font color defined by this template.
int	getFontSize() Get the font size defined by this template.
String	getFontStyle() Get the font style defined by this template.
TemplateTab[]	getTabs() Get the tabs defined by this template.
void	initializeFields(AggregateMetadata store) Determine number of repetitions for each repeatable field.
boolean	isEditable() Returns whether or not fields in this template can be edited.
void	parse(InputStream is) Parses the template options from the given InputStream.
void	populateFields(AggregateMetadata store) Populates the fields using the given OME root node and the template's OME-CA mapping.
boolean	preferCompanion() Returns whether or not the companion-file metadata should take precedence.
void	save(String filename) Save the template to a file.
void	saveFields(AggregateMetadata store) Save fields to given OME root node.

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template(String file)
         throws IOException

Constructs a new Template from the given filename.

Throws:

IOException

Template

public Template(File file)
         throws IOException

Constructs a new Template from the given file.

Throws:

IOException

Template

public Template(InputStream stream)
         throws IOException

Constructs a new Template from the given InputStream.

Throws:

IOException

Template

public Template(TemplateTab[] tabs,
        Hashtable options)

Constructs a new Template from TemplateTabs and a list of options.

Method Detail

parse

public void parse(InputStream is)
           throws IOException

Parses the template options from the given InputStream.

Throws:

IOException

populateFields

public void populateFields(AggregateMetadata store)

Populates the fields using the given OME root node and the template's OME-CA mapping.

saveFields

public void saveFields(AggregateMetadata store)

Save fields to given OME root node.

save

public void save(String filename)
          throws IOException

Save the template to a file.

Throws:

IOException

initializeFields

public void initializeFields(AggregateMetadata store)

Determine number of repetitions for each repeatable field.

changeValue

public void changeValue(String key,
               String value)

Change the value of an option.

getTabs

public TemplateTab[] getTabs()

Get the tabs defined by this template.

getFontStyle

public String getFontStyle()

Get the font style defined by this template.

getFontSize

public int getFontSize()

Get the font size defined by this template.

getFontColor

public int[] getFontColor()

Get the font color defined by this template.

getBackgroundColor

public int[] getBackgroundColor()

Get the background color defined by this template.

getDefaultWidth

public int getDefaultWidth()

Get the default window width defined by this template.

getDefaultHeight

public int getDefaultHeight()

Get the default window height defined by this template.

isEditable

public boolean isEditable()

Returns whether or not fields in this template can be edited.

preferCompanion

public boolean preferCompanion()

Returns whether or not the companion-file metadata should take precedence.

editTemplateFields

public boolean editTemplateFields()

Returns true if we can edit this template on-the-fly.

editMapping

public boolean editMapping()

Returns true if we can edit the OME-CA mapping on-the-fly.