BioLegato 0.7.0 Core API
A B C D E F G I L M N O P R S T U V W

A

aboutPopup() - Static method in class org.biolegato.core.main.BLMain
Displays an about popup for BioLegato.
actionPerformed(ActionEvent) - Method in class org.biolegato.core.properties.PropertiesCheckbox
Handles changes in the status of the checkbox.
addData(Sequence[]) - Static method in class org.biolegato.core.main.BLMain
Adds the data to the canvas.
addExtension(PropertiesExtension) - Method in class org.biolegato.core.properties.BLProperties
Adds a properties extension to the properties registry.
addFormats(JFileChooser, String) - Static method in class org.biolegato.core.plugintypes.DataFormat
This function loads all of the available file formats into a JFileChooser.
addListener(SeqDocListener) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Adds a listener object to the data container.
addListener(SequenceListener) - Method in class org.biolegato.core.data.sequence.Sequence
Adds a sequence listener to keep track of sequence modifications.
addMenuHeading(String) - Static method in class org.biolegato.core.main.BLMain
Adds a menu heading (JMenu) to our menu (BLMenu).
addMenuHeading(int, String) - Static method in class org.biolegato.core.main.BLMain
Adds a menu heading (JMenu) to our menu (BLMenu).
addMenuItem(String, JMenuItem) - Static method in class org.biolegato.core.main.BLMain
Adds a menu item (JMenuItem) to a menu heading (JMenu) within the window (ProgramWindow)
addPropertiesListener(String, PropertiesListener) - Static method in class org.biolegato.core.main.BLMain
Adds a properties listener to the properties object.
addPropertiesListener(String, PropertiesListener) - Method in class org.biolegato.core.properties.BLProperties
Adds a listener for property changes NOTE: this method allows filtering based on which property changed
addSequence(int, Sequence) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Adds a sequence to the data container.
auto(File) - Static method in class org.biolegato.core.plugintypes.DataFormat
Used to auto-detect and parse files into BioLegato sequence objects.
auto(InputStream) - Static method in class org.biolegato.core.plugintypes.DataFormat
Used to auto-detect and parse an input stream's data into BioLegato sequence objects.
auto(BufferedReader) - Static method in class org.biolegato.core.plugintypes.DataFormat
Used to auto-detect and parse data into BioLegato sequence objects.

B

BLMain - Class in org.biolegato.core.main
The main program and generic function class.
BLMain() - Constructor for class org.biolegato.core.main.BLMain
 
BLProperties - Class in org.biolegato.core.properties
Stores the properties for BioLegato.
BLProperties() - Constructor for class org.biolegato.core.properties.BLProperties
Create a new BLProperties instance

C

charType(char) - Method in class org.biolegato.core.data.sequence.Sequence
 
clone() - Method in class org.biolegato.core.data.sequence.Sequence
Clones the current sequence object.
create() - Method in class org.biolegato.core.plugins.PluginWrapper
Creates a new object the plugin class.
create(Class[], Object[]) - Method in class org.biolegato.core.plugins.PluginWrapper
Creates a new object the wrapped plugin class (returns null if unsuccessful).
CURRENT_DIR - Static variable in class org.biolegato.core.main.BLMain
This constant is set to the path of where biolegato was run The value of this constant determined at runtime.

D

DataCanvas - Class in org.biolegato.core.plugintypes
All subclasses are expected to implement a displayable canvas for BioLegato.
DataCanvas(int) - Constructor for class org.biolegato.core.plugintypes.DataCanvas
Creates a new instance of BLCanvas
DataFormat - Class in org.biolegato.core.plugintypes
Class to represent reading of data formats.
DataFormat() - Constructor for class org.biolegato.core.plugintypes.DataFormat
Creates a new instance of DataFormat
DEFAULT_FONT - Static variable in class org.biolegato.core.main.BLMain
The default font for BioLegato
delete(int, int, int) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Removes text from the document.
delete(int, int, int, int) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Removes text from the document.
DOUBLE_CLICK_TIME - Static variable in class org.biolegato.core.main.BLMain
The amount of time between clicks to be considered a double click.

E

envreplace(String) - Static method in class org.biolegato.core.main.BLMain
Replaces $VARIABLE name with environment variables.
error(String) - Static method in class org.biolegato.core.main.BLMain
Sends an error message to BioLegato's standard err.
error(String, String) - Static method in class org.biolegato.core.main.BLMain
Sends an error message to BioLegato's standard err.

F

finalize() - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Finalizes the object - removes all references to itself
finalize() - Method in class org.biolegato.core.data.sequence.Sequence
 

G

get(Object) - Method in class org.biolegato.core.data.sequence.Sequence
Obtains a value for a field of the sequence.
getAllData() - Static method in class org.biolegato.core.main.BLMain
Returns the complete contents of the data in the canvas.
getAllData() - Method in class org.biolegato.core.plugintypes.DataCanvas
Returns the complete contents of the data in the canvas.
getClipboard() - Static method in class org.biolegato.core.main.BLMain
Obtains the current contents of the clipboard (null if empty).
getData() - Static method in class org.biolegato.core.main.BLMain
Returns the current/selected data in the canvas.
getData() - Method in class org.biolegato.core.plugintypes.DataCanvas
Returns the current/selected data in the canvas.
getDefault(String) - Static method in class org.biolegato.core.data.sequence.Sequence
This function obtains the default value of a field for a Sequence.
getFormat(String) - Static method in class org.biolegato.core.plugintypes.DataFormat
Finds the filetype that corresponds to the given hashname (null if not successful).
getgroup(Integer) - Static method in class org.biolegato.core.data.sequence.Sequence
 
getJFrame() - Static method in class org.biolegato.core.main.BLMain
Provides access for other classes to the main program window JFrame object.
getLine(int) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Retrieves a sequence object from the SeqDoc specified by its line number.
getLineCount() - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Returns the number of lines in the document.
getLineLength(int) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Retrieves the length of a line in the document.
getLongestLine() - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Returns the length of the longest line in the data container
getName() - Method in class org.biolegato.core.plugins.PluginWrapper
Returns the class's name.
getName() - Method in class org.biolegato.core.plugintypes.DataFormat
Obtains the name of the file format for File Chooser purposes
getPlugin(String) - Static method in class org.biolegato.core.plugins.PluginLoader
Retrieves a plugin by name.
getPluginHash() - Static method in class org.biolegato.core.plugins.PluginLoader
Maintains a list with all of the plugins loaded by BioLegato.
getPlugins(Class<?>) - Static method in class org.biolegato.core.plugins.PluginLoader
Returns a list with all of the plugins loaded by BioLegato that are instances of the class type indicated.
getProperty(String) - Static method in class org.biolegato.core.main.BLMain
Retrieves individual settings for BioLegato.
getProperty(String) - Method in class org.biolegato.core.properties.BLProperties
Obtains a property from the BLProperties object.
getSeqDoc() - Static method in class org.biolegato.core.main.BLMain
Returns the root sequence document for BioLegato.
getTabName() - Method in class org.biolegato.core.plugintypes.DataCanvas
Returns the name of the canvas.
getTransferData(DataFlavor) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Translates the SeqDoc to the given format
getTransferDataFlavors() - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Dictates what formats the SeqDoc can be converted to.
group(Sequence[]) - Static method in class org.biolegato.core.data.sequence.Sequence
 

I

indexOf(Sequence) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Retrieves the line number for a sequence object in the SeqDoc.
insert(int, int, String) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Inserts a string into the document on a given line.
insert(int, int, Sequence[]) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Inserts sequences at a specific offset in the document.
insertField(String, int, String) - Method in class org.biolegato.core.data.sequence.Sequence
Inserts a string into field within the sequence.
isA(Class<?>) - Method in class org.biolegato.core.plugins.PluginWrapper
Used to test instanceof for the plugin class.
isDataFlavorSupported(DataFlavor) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Dictates whether a given format is supported for conversion
isFormat(Reader) - Method in class org.biolegato.core.plugintypes.DataFormat
Used to auto-detect Bio Legato formats

L

loadMenu() - Static method in class org.biolegato.core.plugintypes.MenuType
Reads a menu into the given window/menu instances.
loadPlugins(String) - Static method in class org.biolegato.core.plugins.PluginLoader
Loads an the plugins into BioLegato.

M

main(String[]) - Static method in class org.biolegato.core.main.BLMain
Starts up BioLegato.
MenuType - Class in org.biolegato.core.plugintypes
An interface for menu reader objects.
MenuType() - Constructor for class org.biolegato.core.plugintypes.MenuType
 
message(String) - Static method in class org.biolegato.core.main.BLMain
Sends a message to BioLegato's standard out.
message(String, String) - Static method in class org.biolegato.core.main.BLMain
Sends a message to BioLegato's standard out.

N

NAME - Static variable in class org.biolegato.core.main.BLMain
This constant stores the program's name

O

org.biolegato.core.data.seqdoc - package org.biolegato.core.data.seqdoc
 
org.biolegato.core.data.sequence - package org.biolegato.core.data.sequence
 
org.biolegato.core.main - package org.biolegato.core.main
 
org.biolegato.core.plugins - package org.biolegato.core.plugins
 
org.biolegato.core.plugintypes - package org.biolegato.core.plugintypes
 
org.biolegato.core.properties - package org.biolegato.core.properties
 

P

PluginLoader - Class in org.biolegato.core.plugins
This class is used to handle plugins.
PluginLoader() - Constructor for class org.biolegato.core.plugins.PluginLoader
 
PluginWrapper - Class in org.biolegato.core.plugins
This class is used to wrap plugins.
PluginWrapper(String, Class<?>) - Constructor for class org.biolegato.core.plugins.PluginWrapper
Creates a new instance of the plugin wrapper class.
PROGRAM_DIR - Static variable in class org.biolegato.core.main.BLMain
This constant is set to the path of BioLegato.jar The value of this constant determined at runtime.
PropertiesCheckbox - Class in org.biolegato.core.properties
Class used to create widgets to obtain boolean values for properties.
PropertiesCheckbox(BLProperties, String, String) - Constructor for class org.biolegato.core.properties.PropertiesCheckbox
Creates a new instance of PropertiesCheckbox
propertiesComponent(Container) - Method in interface org.biolegato.core.plugintypes.PropertiesExtension
Adds a component/container to a properties modification widget.
PropertiesExtension - Interface in org.biolegato.core.plugintypes
This plugin type is for extending BioLegato's property set.
PropertiesListener - Interface in org.biolegato.core.properties
Handler/listener interface for properties changes.
PropertiesNumber - Class in org.biolegato.core.properties
Class used to create widgets to obtain numerical values for properties.
PropertiesNumber(BLProperties, String, String, int, int) - Constructor for class org.biolegato.core.properties.PropertiesNumber
Creates a new instance of PropertiesNumber
propertiesUpdate(String, String) - Method in class org.biolegato.core.properties.PropertiesCheckbox
Handles changes in the status of the associated properties key.
propertiesUpdate(String, String) - Method in interface org.biolegato.core.properties.PropertiesListener
Receives properties update information from BioLegato
propertiesUpdate(String, String) - Method in class org.biolegato.core.properties.PropertiesNumber
Handles changes in the status of the associated properties key.
put(String, Object) - Method in class org.biolegato.core.data.sequence.Sequence
Changes a value of a field in the sequence.

R

readFile(File) - Method in class org.biolegato.core.plugintypes.DataFormat
Reads a file's contained sequences using the file filter's translation.
readStream(BufferedReader) - Static method in class org.biolegato.core.main.BLMain
Reads the complete contents of a BufferedReader into a string.
removeListener(SequenceListener) - Method in class org.biolegato.core.data.sequence.Sequence
Removes a sequence listener from keeping track of sequence modifications.
removeSequence(int) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Removes a sequences from the data container.
removeSequences(int[]) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Removes an array of sequences from the data container.

S

safeExecute(String) - Static method in class org.biolegato.core.main.BLMain
Ensures that the command will be executed properly as a shell command
SeqDoc - Class in org.biolegato.core.data.seqdoc
The internal document format for BioLegato.
SeqDoc() - Constructor for class org.biolegato.core.data.seqdoc.SeqDoc
Creates a new instance of SeqDoc
SeqDoc(Sequence[]) - Constructor for class org.biolegato.core.data.seqdoc.SeqDoc
Creates a new instance of SeqDoc using the existing sequence list
seqDocFlavour - Static variable in class org.biolegato.core.data.seqdoc.SeqDoc
A data flavour representing the SeqDoc data type.
SeqDocListener - Interface in org.biolegato.core.data.seqdoc
The listener class for sequence document objects.
Sequence - Class in org.biolegato.core.data.sequence
This class is used to contain all sequence related functions and data.
Sequence() - Constructor for class org.biolegato.core.data.sequence.Sequence
Constructs new instances of Sequence objects.
Sequence(String) - Constructor for class org.biolegato.core.data.sequence.Sequence
Constructs new instances of Sequence objects.
Sequence(Map<String, Object>) - Constructor for class org.biolegato.core.data.sequence.Sequence
Constructs new instances of sequence.
Sequence.CharacterClass - Enum in org.biolegato.core.data.sequence
Used for typing characters within a sequence.
Sequence.Direction - Enum in org.biolegato.core.data.sequence
Used for typing/storing sequence direction.
Sequence.Strandedness - Enum in org.biolegato.core.data.sequence
Used for typing/storing sequence strandedness.
Sequence.Topology - Enum in org.biolegato.core.data.sequence
Used for typing/storing sequence topology.
Sequence.Type - Enum in org.biolegato.core.data.sequence
This enum is used for typing/storing sequence types.
sequenceAdded(SeqDoc, int, Sequence) - Method in interface org.biolegato.core.data.seqdoc.SeqDocListener
This method is called when a sequence is added to a SeqDoc.
sequenceChanged(Sequence, String) - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Called when a field in a sequence is modified.
sequenceChanged(SeqDoc, int, Sequence, String) - Method in interface org.biolegato.core.data.seqdoc.SeqDocListener
This method is called when a field in a sequence is modified.
sequenceChanged(Sequence, String) - Method in interface org.biolegato.core.data.sequence.SequenceListener
This method is called when a field in a sequence is modified.
sequenceFlavour - Static variable in class org.biolegato.core.data.sequence.Sequence
A data flavour representing the raw Sequence data type.
SequenceListener - Interface in org.biolegato.core.data.sequence
This listener received change events from sequences.
sequenceRemoved(SeqDoc, int, Sequence) - Method in interface org.biolegato.core.data.seqdoc.SeqDocListener
This method is called when a sequence is removed from the SeqDoc class.
serialVersionUID - Static variable in class org.biolegato.core.main.BLMain
This constant is used for Serialization
setClipboard(Sequence[]) - Static method in class org.biolegato.core.main.BLMain
Changes the current contents of the clipboard.
setProperty(String, String) - Static method in class org.biolegato.core.main.BLMain
Changes properties for BioLegato.
setProperty(String, String) - Method in class org.biolegato.core.properties.BLProperties
Changes a property within the BLProperties object
shellCommand(String, String) - Static method in class org.biolegato.core.main.BLMain
Runs simple shell commands.
showPropertiesWindow(JFrame) - Method in class org.biolegato.core.properties.BLProperties
Displays the properties window for this instance of BioLegato
smethod(String) - Method in class org.biolegato.core.plugins.PluginWrapper
Invokes a static method from the plugin.
smethod(String, Class[], Object[]) - Method in class org.biolegato.core.plugins.PluginWrapper
Invokes a static method from the plugin (returns null if not successful).
stateChanged(ChangeEvent) - Method in class org.biolegato.core.plugintypes.DataCanvas
Refreshes the canvas on tab changes.
stateChanged(ChangeEvent) - Method in class org.biolegato.core.properties.PropertiesNumber
Handles changes in the status of the spinner.

T

testNumber(char[]) - Static method in class org.biolegato.core.main.BLMain
Checks if a character array is all digits.
toArray() - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Converts the SeqDoc into a sequence array representation
toString() - Method in class org.biolegato.core.data.seqdoc.SeqDoc
Converts the SeqDoc into a string representation
toString() - Method in class org.biolegato.core.data.sequence.Sequence
Creates a string representation of the Sequence and its fields
translateFrom(BufferedReader) - Method in class org.biolegato.core.plugintypes.DataFormat
Translates a string from the given file format into the BioLegato internal format.
translateTo(Sequence) - Method in class org.biolegato.core.plugintypes.DataFormat
Translates a string from the BioLegato internal format to the given file format.

U

ungroup(Sequence[]) - Static method in class org.biolegato.core.data.sequence.Sequence
 

V

valueOf(String) - Static method in enum org.biolegato.core.data.sequence.Sequence.CharacterClass
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.biolegato.core.data.sequence.Sequence.Direction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.biolegato.core.data.sequence.Sequence.Strandedness
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.biolegato.core.data.sequence.Sequence.Topology
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.biolegato.core.data.sequence.Sequence.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.biolegato.core.data.sequence.Sequence.CharacterClass
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum org.biolegato.core.data.sequence.Sequence.Direction
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum org.biolegato.core.data.sequence.Sequence.Strandedness
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum org.biolegato.core.data.sequence.Sequence.Topology
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum org.biolegato.core.data.sequence.Sequence.Type
Returns an array containing the constants of this enum type, in the order they're declared.
VERSION - Static variable in class org.biolegato.core.main.BLMain
This constant is used to keep track of version changes.

W

warning(String) - Static method in class org.biolegato.core.main.BLMain
Sends an warning message to BioLegato's standard err.
warning(String, String) - Static method in class org.biolegato.core.main.BLMain
Sends an warning message to BioLegato's standard err.
writeFile(File, Sequence[]) - Method in class org.biolegato.core.plugintypes.DataFormat
Writes a list of sequences to a file.

A B C D E F G I L M N O P R S T U V W
BioLegato 0.7.0 Core API

Copyright © 2008-2010 University of Manitoba.