Package qupath.lib.gui.scripting.languages

Class DefaultScriptLanguage

java.lang.Object

qupath.lib.scripting.languages.ScriptLanguage

qupath.lib.gui.scripting.languages.DefaultScriptLanguage

All Implemented Interfaces:

ExecutableLanguage

Direct Known Subclasses:

GroovyLanguage

public class DefaultScriptLanguage
extends ScriptLanguage
implements ExecutableLanguage

Default implementation for a ScriptLanguage, based on a ScriptEngine.

Since:

v0.4.0

Author:

Melvin Gelbard, Pete Bankhead

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	DefaultScriptLanguage.ImportStatementGenerator	Interface defining how the import statements should be generated for the language.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final DefaultScriptLanguage.ImportStatementGenerator	JAVA_IMPORTER	Java-like import statements
protected static final DefaultScriptLanguage.ImportStatementGenerator	PYTHON_IMPORTER	Pythonic import statements

Constructor Summary

Constructors

Constructor	Description
DefaultScriptLanguage(String name, Collection<String> exts, ScriptAutoCompletor completor)	Constructor for a ExecutableLanguage.
DefaultScriptLanguage(ScriptEngineFactory factory)	Constructor for a ExecutableLanguage based on a ScriptEngineFactory.

Method Summary

Modifier and Type	Method	Description
protected ScriptContext	createContext(ScriptParameters params)	Create a ScriptContext containing information from the ScriptParameters.
Object	execute(ScriptParameters params)	Execute the given script String.
ScriptAutoCompletor	getAutoCompletor()	Get the ScriptAutoCompletor object that takes care of this language's auto-completion.
protected ScriptAutoCompletor	getDefaultAutoCompletor(String languageName)	Default method to get a suitable auto completor for the given language name.
protected String	getDefaultScriptName()
protected DefaultScriptLanguage.ImportStatementGenerator	getImportStatementGenerator()	Get an DefaultScriptLanguage.ImportStatementGenerator.
String	getImportStatements(Collection<Class<?>> classes)	Get the import statements as a String, to add at the beginning of the executed script.
String	getStaticImportStatements(Collection<Class<?>> classes)	Get the static import statements as a String, to add at the beginning of the executed script.
protected String	tryToInterpretMessage(Throwable cause, int line, boolean defaultImportsAvailable)

Methods inherited from class qupath.lib.scripting.languages.ScriptLanguage

getExtensions, getName, toString

Methods inherited from class java.lang.Object

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

Field Details

JAVA_IMPORTER

protected static final DefaultScriptLanguage.ImportStatementGenerator JAVA_IMPORTER

Java-like import statements

PYTHON_IMPORTER

protected static final DefaultScriptLanguage.ImportStatementGenerator PYTHON_IMPORTER

Pythonic import statements

Constructor Details

DefaultScriptLanguage

public DefaultScriptLanguage(ScriptEngineFactory factory)

Constructor for a ExecutableLanguage based on a ScriptEngineFactory.

Note: the scriptEngine is not stored within this class. It is always fetched via ScriptLanguageProvider.

Parameters:

factory -

DefaultScriptLanguage

public DefaultScriptLanguage(String name,
 Collection<String> exts,
 ScriptAutoCompletor completor)

Constructor for a ExecutableLanguage.

Note: the scriptEngine is not stored within this class. It is always fetched via ScriptLanguageProvider.

Parameters:

name - the language name

exts - the possible extensions for this language

completor - the auto-completion object for this language

Method Details

getDefaultAutoCompletor

protected ScriptAutoCompletor getDefaultAutoCompletor(String languageName)

Default method to get a suitable auto completor for the given language name.

Parameters:

languageName -

Returns:

execute

public Object execute(ScriptParameters params)
               throws ScriptException

Description copied from interface: ExecutableLanguage

Execute the given script String.

Specified by:

execute in interface ExecutableLanguage

Parameters:

params -

Returns:

Throws:

ScriptException

tryToInterpretMessage

protected String tryToInterpretMessage(Throwable cause,
 int line,
 boolean defaultImportsAvailable)

getDefaultScriptName

protected String getDefaultScriptName()

createContext

protected ScriptContext createContext(ScriptParameters params)

Create a ScriptContext containing information from the ScriptParameters.

Parameters:

params -

Returns:

getAutoCompletor

public ScriptAutoCompletor getAutoCompletor()

Description copied from class: ScriptLanguage

Get the ScriptAutoCompletor object that takes care of this language's auto-completion.

Can return null if the script editor should not handle auto-completion for this language.

Overrides:

getAutoCompletor in class ScriptLanguage

Returns:

auto-completor

getImportStatements

public String getImportStatements(Collection<Class<?>> classes)

Get the import statements as a String, to add at the beginning of the executed script.

Parameters:

classes - a collection of the classes to import

Returns:

import string

getStaticImportStatements

public String getStaticImportStatements(Collection<Class<?>> classes)

Get the static import statements as a String, to add at the beginning of the executed script.

Parameters:

classes - a collection of classes to import as static classes

Returns:

import string

getImportStatementGenerator

protected DefaultScriptLanguage.ImportStatementGenerator getImportStatementGenerator()

Get an DefaultScriptLanguage.ImportStatementGenerator. This attempts to make an educated guess, returning JAVA_IMPORTER or PYTHON_IMPORTER based on the name

Returns: