Articles in this section

See more

Packages and Classes

  • Updated
Follow

Packages and Classes

To access the classes provided by the Etlworks Java API, you need to import a particular package. It is possible to import multiple packages into the same JavaScript program.

For example:

importPackage(com.toolsverse.etl.common);
importPackage(com.toolsverse.util); 

// the rest of the code

Some of the most commonly used packages

Used for Import JavaDoc
Utility classes importPackage(com.toolsverse.util); util
Logging importPackage(com.toolsverse.util.log); util.log
System Configuration importPackage(com.toolsverse.config); config
Common ETL engine classes, such as DataSet, FieldDef, etc. importPackage(com.toolsverse.etl.common); etl.common
ETL engine configuration importPackage(com.toolsverse.etl.core.config); etl.core.config
ETL engine core importPackage(com.toolsverse.etl.core.engine); etl.core.engine
Common ETL engine tasks importPackage(com.toolsverse.etl.core.task.common); etl.core.task.common
Common Java data structures and collection classes importPackage(java.util); java.util

 

Some of the most commonly used classes

Used for Class name / JavaDoc Usage Example
Utility methods com.toolsverse.util.Utils 
importPackage(com.toolsverse.util);

if (Utils.isNothing(value)) {do something}
Working with file names com.toolsverse.util.FilenameUtils 
importPackage(com.toolsverse.util);

var name = FilenameUtils.getName(value);
Logging com.toolsverse.util.log.Logger 
importPackage(com.toolsverse.util);

Logger.log(Logger.SEVERE, null, "Error doing something");
System Configuration com.toolsverse.config.SystemConfig 
importPackage(com.toolsverse.config);

var props = SystemConfig.instance().getProperties();
Accessing data com.toolsverse.etl.common.DataSet 
importPackage(com.toolsverse.etl.common);

var fldValue = dataSet.getFieldValue(currentRow, 
"InvoiceNo");
Accessing dataset field com.toolsverse.etl.common.FieldDef 
importPackage(com.toolsverse.etl.common);

var fldName = dataSet.getFieldDef("InvoiceNo").
getNameToUse();
Accessing dataset record com.toolsverse.etl.common.DataSetRecord 
importPackage(com.toolsverse.etl.common);

var record = dataSet.getRecord(0);
High level transformations com.toolsverse.etl.common.CommonEtlUtils 
importPackage(com.toolsverse.etl.common);

var newDs = CommonEtlUtils.intersect(dataSet, with, "id");
Connection information com.toolsverse.etl.common.Alias 
importPackage(com.toolsverse.etl.common);

var alias = etlConfig.getAliasesMap().
get('Connection name');
ETL Engine configuration com.toolsverse.etl.core.config.EtlConfig 
importPackage(com.toolsverse.etl.common);

var alias = etlConfig.getAliasesMap().
get('Connection name');
ETL scenario com.toolsverse.etl.core.engine.Scenario 
importPackage(com.toolsverse.etl.common);

var source = scenario.getSources().get('Source name');
Validation com.toolsverse.etl.core.engine.TaskResult 
importPackage(com.toolsverse.etl.common);

if (dataSet.getFieldValue(currentRow, 'SUCCESS').
toString() == 'error') {value = TaskResult.HALT;}
Checking if files exist com.toolsverse.etl.core.task.common.FileManagerTask 
importPackage(com.toolsverse.etl.core.task.common);

var ret = !FileManagerTask.filesExist(etlConfig, 
'name of the connection', '*.json') ? null : "true";
Getting list of files by wildcard com.toolsverse.etl.core.task.common.FileManagerTask 
importPackage(com.toolsverse.etl.core.task.common);

var list = FileManagerTask.list(etlConfig, 
'name of the connection', '*.json');

if (list != null) {
   for each (var file in list) {
       etlConfig.log("Name:" + file.getName() + 
", Size:" + file.getSize() + 
", Path:" + file.getPath() + 
", Last modified:" + file.getLastModified());
   }
}
Writing files or making HTTP calls com.toolsverse.etl.core.task.common.FileManagerTask 
importPackage(com.toolsverse.etl.core.task.common);

FileManagerTask.write(etlConfig, 
"name of the connection", 
filename, payload);
Reading files com.toolsverse.etl.core.task.common.FileManagerTask 
importPackage(com.toolsverse.etl.core.task.common);

var data = FileManagerTask.read(etlConfig, 
"name of the connection", 
filename);

 

Related articles

Comments

0 comments

Please sign in to leave a comment.