A C D E F G H I J M O P R S T V W

A

addDataSection(Operation, OperationCode, InOut) - Method in class eu.scape_project.xa.tw.gen.ServiceCodeCreator

Add an input/output data section to the operation

addOperation(OperationCode) - Method in class eu.scape_project.xa.tw.tmpl.ServiceCode

addOperation(ServiceXmlOp) - Method in class eu.scape_project.xa.tw.tmpl.ServiceXml

addOutFileItem(String) - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

addParameter(String) - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

addResultElement(String) - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

addVariable(String, String) - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Adds a key value pair to the subsitutor

appendInputSection(String) - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

Append code to the input section

appendOutputSection(String) - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

Append code to the output section

applySubstitution(String, String) - Method in class eu.scape_project.xa.tw.gen.Substitutor

Apply substitution

applySubstitution(String) - Method in class eu.scape_project.xa.tw.gen.Substitutor

Apply substitution

C

checkpoint() - Method in class eu.scape_project.xa.tw.gen.ToolspecValidator

close(Closeable) - Static method in class eu.scape_project.xa.tw.util.FileUtil

Code - Class in eu.scape_project.xa.tw.tmpl

Abstract class for code templates that can be evaluated by the Velocity template engine.

Code(String) - Constructor for class eu.scape_project.xa.tw.tmpl.Code

Constructs a Code object from a template file

Configuration - Class in eu.scape_project.xa.tw.conf

Configuration files

Configuration() - Constructor for class eu.scape_project.xa.tw.conf.Configuration

Default constructor

Constants - Class in eu.scape_project.xa.tw

create(String) - Method in class eu.scape_project.xa.tw.tmpl.GenericCode

create(String) - Method in class eu.scape_project.xa.tw.tmpl.ServiceCode

create(String) - Method in class eu.scape_project.xa.tw.tmpl.ServiceXml

createOperations() - Method in class eu.scape_project.xa.tw.gen.ServiceCodeCreator

Create operations

createPom() - Method in class eu.scape_project.xa.tw.gen.DeploymentCreator

Insert data types

D

DEFAULT_PROJECT_PROPERTIES - Static variable in class eu.scape_project.xa.tw.Constants

Default project properties file name

DEFAULT_TOOLSPEC - Static variable in class eu.scape_project.xa.tw.Constants

Default toolspec xml file

deleteTempFiles(File) - Static method in class eu.scape_project.xa.tw.util.FileUtil

This method deletes all the content in a folder, without the need of passing it a PlanetsLogger instance!

DeploymentCreator - Class in eu.scape_project.xa.tw.gen

DeploymentCreator(String, Service, PropertiesSubstitutor) - Constructor for class eu.scape_project.xa.tw.gen.DeploymentCreator

Constructor for a DeploymentCreator

deriveVariables() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Derives some variables from the service definition

E

ErrType - Enum in eu.scape_project.xa.tw.gen.types

Message Type

eu.scape_project.xa.tw - package eu.scape_project.xa.tw

eu.scape_project.xa.tw.cli - package eu.scape_project.xa.tw.cli

eu.scape_project.xa.tw.conf - package eu.scape_project.xa.tw.conf

eu.scape_project.xa.tw.gen - package eu.scape_project.xa.tw.gen

eu.scape_project.xa.tw.gen.types - package eu.scape_project.xa.tw.gen.types

eu.scape_project.xa.tw.tmpl - package eu.scape_project.xa.tw.tmpl

eu.scape_project.xa.tw.util - package eu.scape_project.xa.tw.util

evaluate() - Method in class eu.scape_project.xa.tw.tmpl.Code

Apply the Velocity evaluation

F

FileUtil - Class in eu.scape_project.xa.tw.util

These are generic file utilities used by the client and service.

G

GeneratorException - Exception in eu.scape_project.xa.tw.gen

GeneratorException

GeneratorException() - Constructor for exception eu.scape_project.xa.tw.gen.GeneratorException

Default constructor

GeneratorException(String) - Constructor for exception eu.scape_project.xa.tw.gen.GeneratorException

Construct exception with message

GeneratorException(String, Throwable) - Constructor for exception eu.scape_project.xa.tw.gen.GeneratorException

Construct with message and cause

GenericCode - Class in eu.scape_project.xa.tw.tmpl

Template-based service code generator.

GenericCode(String) - Constructor for class eu.scape_project.xa.tw.tmpl.GenericCode

Constructor for a service code instance

getCode() - Method in class eu.scape_project.xa.tw.tmpl.Code

Get the code (after the Velocity evaluation is completed)

getContext() - Method in class eu.scape_project.xa.tw.gen.Substitutor

getContextProp(String) - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Note that the velocity context variables are underscore (_) separated, e.g.

getCtx() - Method in class eu.scape_project.xa.tw.tmpl.Code

getDirectory() - Method in class eu.scape_project.xa.tw.gen.ServiceDef

getGenerateDir() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Getter for the generated directory

getGlobalProjectPrefix() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Getter for the global project prefix

getInputSection() - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

getKeyValuePairs() - Method in class eu.scape_project.xa.tw.util.PropertyUtil

getMidfix() - Method in class eu.scape_project.xa.tw.gen.ServiceDef

getName() - Method in class eu.scape_project.xa.tw.gen.ServiceDef

getOperationName() - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

getOperations() - Method in class eu.scape_project.xa.tw.tmpl.ServiceCode

getOperations() - Method in class eu.scape_project.xa.tw.tmpl.ServiceXml

getOpid() - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

getOutFileItems() - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

getOutputSection() - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

getParameters() - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

getParametersCsList() - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

getProjConf() - Method in class eu.scape_project.xa.tw.conf.Configuration

getProjectConfigurationFile() - Method in class eu.scape_project.xa.tw.conf.Configuration

getProjectDirectory() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Getter for the project midfix (e.g.

getProjectMidfix() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Getter for the project midfix (e.g.

getProjectPackagePath() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Getter for the project midfix (e.g.

getProjectResourcesDir() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Getter for the resources directory

getProp(String) - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Note that the properties are dot separated like defined in the properties file (e.g.

getProp(String) - Method in class eu.scape_project.xa.tw.util.PropertyUtil

get a property value by key

getPropertyUtils() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Getter for the property utils

getResultElements() - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

getServiceDef() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

getSystemTempFolder() - Static method in class eu.scape_project.xa.tw.util.FileUtil

Get system's JAVA temporary directory.

getTemplateDir() - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Getter for the template directory

getTmpFile(String, String) - Static method in class eu.scape_project.xa.tw.util.FileUtil

Get temporary file

getTmpFile(byte[], String, String) - Static method in class eu.scape_project.xa.tw.util.FileUtil

Get temporary file

getVersion() - Method in class eu.scape_project.xa.tw.gen.ServiceDef

getXmlConf() - Method in class eu.scape_project.xa.tw.conf.Configuration

H

hasConfig() - Method in class eu.scape_project.xa.tw.conf.Configuration

hasXmlConf() - Method in class eu.scape_project.xa.tw.conf.Configuration

I

insertDataTypes() - Method in class eu.scape_project.xa.tw.gen.WsdlCreator

Insert data types

IOType - Enum in eu.scape_project.xa.tw.gen.types

isValid() - Method in class eu.scape_project.xa.tw.gen.ToolspecValidator

J

JAVA_TMP - Static variable in class eu.scape_project.xa.tw.util.FileUtil

The Java property for the system temp directory

M

main(String[]) - Static method in class eu.scape_project.xa.tw.cli.ToolWrapper

Main method of the command line application

makePath(String...) - Static method in class eu.scape_project.xa.tw.util.FileUtil

mkdir(File) - Static method in class eu.scape_project.xa.tw.util.FileUtil

mkdirs(File) - Static method in class eu.scape_project.xa.tw.util.FileUtil

MsgType - Enum in eu.scape_project.xa.tw.gen.types

Message Type

O

OperationCode - Class in eu.scape_project.xa.tw.tmpl

Operation code that can be evaluated by the Velocity template engine.

OperationCode(String, int) - Constructor for class eu.scape_project.xa.tw.tmpl.OperationCode

OutputItemCode - Class in eu.scape_project.xa.tw.tmpl

Template-based service code generator.

OutputItemCode(String) - Constructor for class eu.scape_project.xa.tw.tmpl.OutputItemCode

Constructor for a service code instance

P

packageNameToNamespace(String) - Static method in class eu.scape_project.xa.tw.util.StringConverterUtil

Package name to namespace

packageNameToPackagePath(String) - Static method in class eu.scape_project.xa.tw.util.StringConverterUtil

Creates a file path from a package name

processDirectory(File) - Method in class eu.scape_project.xa.tw.gen.Substitutor

Process directory recursively, only if a file is found, the subsitution is applied.

processFile(File) - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

processFile(File) - Method in class eu.scape_project.xa.tw.gen.Substitutor

PROJECT_NAME - Static variable in class eu.scape_project.xa.tw.Constants

Name of project

PropertiesSubstitutor - Class in eu.scape_project.xa.tw.gen

PropertiesSubstitutor

PropertiesSubstitutor() - Constructor for class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Default constructor

PropertiesSubstitutor(String) - Constructor for class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

Reads the properties from the project configuration properties file and creates the substitution variable map.

PropertyUtil - Class in eu.scape_project.xa.tw.util

PropertyUtils

PropertyUtil(String) - Constructor for class eu.scape_project.xa.tw.util.PropertyUtil

Construct the property utils object from the properties file

propToVar(String) - Static method in class eu.scape_project.xa.tw.util.StringConverterUtil

Converts property names to variable names, in an arbitrary fashion (replaces all occurrences of "." in the var name with "_".

put(String, String) - Method in class eu.scape_project.xa.tw.tmpl.Code

Add a key value pair to the Velocity context

put(VelocityContext) - Method in class eu.scape_project.xa.tw.tmpl.Code

put(String, List<String>) - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

Add a list of operations to the Velocity context

put(String, List<OperationCode>) - Method in class eu.scape_project.xa.tw.tmpl.ServiceCode

Add a list of operations to the Velocity context

put(String, List<ServiceXmlOp>) - Method in class eu.scape_project.xa.tw.tmpl.ServiceXml

Add a list of operations to the Velocity context

putKeyValuePair(String, String) - Method in class eu.scape_project.xa.tw.gen.Substitutor

Add a new key-value pair to the velocity context, note that the dot (.) in the variable is replaced by underscore (_) because this character is used for accessing sub-properties in the Velocity VTL.

R

replaceVars(String) - Method in class eu.scape_project.xa.tw.gen.Substitutor

Replace variables

ResultElementCode - Class in eu.scape_project.xa.tw.tmpl

Template-based service code generator.

ResultElementCode(String) - Constructor for class eu.scape_project.xa.tw.tmpl.ResultElementCode

Constructor for a service code instance

S

SectionCode - Class in eu.scape_project.xa.tw.tmpl

Template-based service code generator.

SectionCode(String) - Constructor for class eu.scape_project.xa.tw.tmpl.SectionCode

Constructor for a service code instance

ServiceCode - Class in eu.scape_project.xa.tw.tmpl

Template-based service code generator.

ServiceCode(String) - Constructor for class eu.scape_project.xa.tw.tmpl.ServiceCode

Constructor for a service code instance

ServiceCodeCreator - Class in eu.scape_project.xa.tw.gen

ServiceCodeCreator(PropertiesSubstitutor, ServiceCode, ServiceXml, List<Operation>) - Constructor for class eu.scape_project.xa.tw.gen.ServiceCodeCreator

Constructor of the service code creator

ServiceDef - Class in eu.scape_project.xa.tw.gen

Tool

ServiceDef(String, String) - Constructor for class eu.scape_project.xa.tw.gen.ServiceDef

The service definition is based on the name of the service and the version of the tool.

ServiceXml - Class in eu.scape_project.xa.tw.tmpl

Template-based service code generator.

ServiceXml(String) - Constructor for class eu.scape_project.xa.tw.tmpl.ServiceXml

Constructor for a service code instance

ServiceXmlOp - Class in eu.scape_project.xa.tw.tmpl

Template-based service code generator.

ServiceXmlOp(String) - Constructor for class eu.scape_project.xa.tw.tmpl.ServiceXmlOp

Constructor for a service code instance

setCode(String) - Method in class eu.scape_project.xa.tw.tmpl.Code

setOperationName(String) - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

setOpid(int) - Method in class eu.scape_project.xa.tw.tmpl.OperationCode

setProjConf(File) - Method in class eu.scape_project.xa.tw.conf.Configuration

setServiceDef(ServiceDef) - Method in class eu.scape_project.xa.tw.gen.PropertiesSubstitutor

setXmlConf(File) - Method in class eu.scape_project.xa.tw.conf.Configuration

StringConverterUtil - Class in eu.scape_project.xa.tw.util

StringConverterUtil

StringConverterUtil() - Constructor for class eu.scape_project.xa.tw.util.StringConverterUtil

Substitutor - Class in eu.scape_project.xa.tw.gen

GenericSubstitutor

Substitutor() - Constructor for class eu.scape_project.xa.tw.gen.Substitutor

Constructor of the generic substitutor which initialises the velocity engine and the context containing the key value pairs.

T

ToolspecValidator - Class in eu.scape_project.xa.tw.gen

ToolspecValidator(Toolspec, Configuration) - Constructor for class eu.scape_project.xa.tw.gen.ToolspecValidator

Public constructor for a ToolspecValidator from a ToolSpec and a Configuration object

ToolWrapper - Class in eu.scape_project.xa.tw.cli

Command line interface of the tool wrapper.

ToolWrapper() - Constructor for class eu.scape_project.xa.tw.cli.ToolWrapper

Default constructor

typeToFilename(String) - Static method in class eu.scape_project.xa.tw.util.StringConverterUtil

Converts type names to file names, substitutes ":" for "_"

V

validate() - Method in class eu.scape_project.xa.tw.gen.ToolspecValidator

validateWithXMLSchema() - Method in class eu.scape_project.xa.tw.gen.ToolspecValidator

valueOf(String) - Static method in enum eu.scape_project.xa.tw.gen.types.ErrType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.scape_project.xa.tw.gen.types.IOType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum eu.scape_project.xa.tw.gen.types.MsgType

Returns the enum constant of this type with the specified name.

values() - Static method in enum eu.scape_project.xa.tw.gen.types.ErrType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.scape_project.xa.tw.gen.types.IOType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum eu.scape_project.xa.tw.gen.types.MsgType

Returns an array containing the constants of this enum type, in the order they are declared.

varToProp(String) - Static method in class eu.scape_project.xa.tw.util.StringConverterUtil

Converts variable names to property names, in an arbitrary fashion (replaces all occurrences of "_" in the var name with ".".

ve - Variable in class eu.scape_project.xa.tw.gen.Substitutor

W

WsdlCreator - Class in eu.scape_project.xa.tw.gen

WsdlCreator(PropertiesSubstitutor, String, String, List<Operation>) - Constructor for class eu.scape_project.xa.tw.gen.WsdlCreator

Constructor for a new wsdl creator

A C D E F G H I J M O P R S T V W