Packages and Classes
To access the classes provided by the Etlworks Java API, you either use a fully qualified class name or import required package(s).
Using fully qualified Java class name
Example
var props = com.toolsverse.config.SystemConfig.instance().getProperties();
Using fully qualified Java class names is a recommended approach. It is the fastest and creates no overhead when executing JavaScript.
Importing packages using importPackage
To import one or multiple packages into the JavaScript program use importPackage function.
Example:
importPackage(com.toolsverse.etl.common);
importPackage(com.toolsverse.util);
// the rest of the code
Importing packages using JavaImporter
To import one or multiple packages into the JavaScript program use JavaImporter function.
Example:
var javaImports = new JavaImporter(com.toolsverse.etl.common, com.toolsverse.util);
with (javaImports) {
// the rest of the code
}
This is slower than using fully qualified Java class names or importPackage.
Some of the most commonly used packages
Used for | Package | JavaDoc |
---|---|---|
Utility classes | com.toolsverse.util |
util |
Logging | com.toolsverse.util.log) |
util.log |
System Configuration | com.toolsverse.config) |
config |
Common ETL engine classes, such as DataSet, FieldDef, etc. | com.toolsverse.etl.common |
etl.common |
ETL engine configuration | com.toolsverse.etl.core.config |
etl.core.config |
ETL engine core | com.toolsverse.etl.core.engine |
etl.core.engine |
Common ETL engine tasks | com.toolsverse.etl.core.task.common) |
etl.core.task.common |
Common Java data structures and collection classes | java.util |
java.util |
Some of the most commonly used classes
Used for | Class name / JavaDoc | Usage Example |
---|---|---|
Utility methods | com.toolsverse.util.Utils |
if (com.toolsverse.util.Utils.isNothing(value)) {do something} |
Working with file names | com.toolsverse.util.FilenameUtils |
var name = com.toolsverse.util.FilenameUtils.getName(value); |
Logging | com.toolsverse.util.log.Logger |
com.toolsverse.util.log.Logger.log(com.toolsverse.util.log.Logger.SEVERE, |
System Configuration | com.toolsverse.config.SystemConfig |
var props =com.toolsverse.config.SystemConfig.instance().getProperties(); |
Accessing data | com.toolsverse.etl.common.DataSet |
var fldValue = dataSet.getFieldValue(currentRow, |
Accessing dataset field | com.toolsverse.etl.common.FieldDef |
var fldName = dataSet.getFieldDef("InvoiceNo"). |
Accessing dataset record | com.toolsverse.etl.common.DataSetRecord |
var record = dataSet.getRecord(0); |
High level transformations | com.toolsverse.etl.common.CommonEtlUtils |
var newDs = com.toolsverse.etl.common.CommonEtlUtils.intersect(dataSet, with, "id"); |
Connection information | com.toolsverse.etl.common.Alias |
var alias = etlConfig.getAliasesMap(). |
ETL Engine configuration | com.toolsverse.etl.core.config.EtlConfig |
var alias = etlConfig.getAliasesMap(). |
ETL scenario | com.toolsverse.etl.core.engine.Scenario |
var source = scenario.getSources().get('Source name'); |
Validation | com.toolsverse.etl.core.engine.TaskResult |
if (dataSet.getFieldValue(currentRow, 'SUCCESS'). |
Checking if files exist | com.toolsverse.etl.core.task.common.FileManagerTask |
var ret = !com.toolsverse.etl.core.task.common.FileManagerTask.filesExist(etlConfig, |
Getting list of files by wildcard | com.toolsverse.etl.core.task.common.FileManagerTask |
var list = com.toolsverse.etl.core.task.common.FileManagerTask.list(etlConfig, |
Writing files or making HTTP calls | com.toolsverse.etl.core.task.common.FileManagerTask |
com.toolsverse.etl.core.task.common.FileManagerTask.write(etlConfig, |
Reading files | com.toolsverse.etl.core.task.common.FileManagerTask |
var data = com.toolsverse.etl.core.task.common.FileManagerTask.read(etlConfig, |
Comments
0 comments
Please sign in to leave a comment.