org.pentaho.di.trans.steps.excelinput.ExcelInputMeta Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kettle-engine Show documentation
Show all versions of kettle-engine Show documentation
Container pom for Pentaho Data Integration modules
The newest version!
/*! ******************************************************************************
*
* Pentaho Data Integration
*
* Copyright (C) 2002-2018 by Hitachi Vantara : http://www.pentaho.com
*
*******************************************************************************
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
******************************************************************************/
package org.pentaho.di.trans.steps.excelinput;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.vfs2.FileObject;
import org.pentaho.di.core.CheckResult;
import org.pentaho.di.core.CheckResultInterface;
import org.pentaho.di.core.Const;
import org.pentaho.di.core.encryption.Encr;
import org.pentaho.di.core.injection.AfterInjection;
import org.pentaho.di.core.util.StringUtil;
import org.pentaho.di.core.util.Utils;
import org.pentaho.di.core.database.DatabaseMeta;
import org.pentaho.di.core.exception.KettleException;
import org.pentaho.di.core.exception.KettlePluginException;
import org.pentaho.di.core.exception.KettleStepException;
import org.pentaho.di.core.exception.KettleXMLException;
import org.pentaho.di.core.fileinput.FileInputList;
import org.pentaho.di.core.injection.Injection;
import org.pentaho.di.core.injection.InjectionDeep;
import org.pentaho.di.core.injection.InjectionSupported;
import org.pentaho.di.core.row.RowMeta;
import org.pentaho.di.core.row.RowMetaInterface;
import org.pentaho.di.core.row.ValueMetaInterface;
import org.pentaho.di.core.row.value.ValueMetaBoolean;
import org.pentaho.di.core.row.value.ValueMetaDate;
import org.pentaho.di.core.row.value.ValueMetaFactory;
import org.pentaho.di.core.row.value.ValueMetaInteger;
import org.pentaho.di.core.row.value.ValueMetaNone;
import org.pentaho.di.core.row.value.ValueMetaString;
import org.pentaho.di.core.variables.VariableSpace;
import org.pentaho.di.core.vfs.KettleVFS;
import org.pentaho.di.core.xml.XMLHandler;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.repository.ObjectId;
import org.pentaho.di.repository.Repository;
import org.pentaho.di.resource.ResourceDefinition;
import org.pentaho.di.resource.ResourceNamingInterface;
import org.pentaho.di.trans.Trans;
import org.pentaho.di.trans.TransMeta;
import org.pentaho.di.trans.step.BaseStepMeta;
import org.pentaho.di.trans.step.StepDataInterface;
import org.pentaho.di.trans.step.StepInterface;
import org.pentaho.di.trans.step.StepMeta;
import org.pentaho.di.trans.step.StepMetaInterface;
import org.pentaho.metastore.api.IMetaStore;
import org.w3c.dom.Node;
/**
* Meta data for the Excel step.
*/
@InjectionSupported( localizationPrefix = "ExcelInput.Injection.", groups = { "FIELDS", "SHEETS", "FILENAME_LINES" } )
public class ExcelInputMeta extends BaseStepMeta implements StepMetaInterface {
private static Class PKG = ExcelInputMeta.class; // for i18n purposes, needed by Translator2!!
public static final String[] RequiredFilesDesc = new String[] {
BaseMessages.getString( PKG, "System.Combo.No" ), BaseMessages.getString( PKG, "System.Combo.Yes" ) };
public static final String[] RequiredFilesCode = new String[] { "N", "Y" };
private static final String NO = "N";
private static final String YES = "Y";
public static final int TYPE_TRIM_NONE = 0;
public static final int TYPE_TRIM_LEFT = 1;
public static final int TYPE_TRIM_RIGHT = 2;
public static final int TYPE_TRIM_BOTH = 3;
public static final String[] type_trim_code = { "none", "left", "right", "both" };
public static final String[] type_trim_desc = {
BaseMessages.getString( PKG, "ExcelInputMeta.TrimType.None" ),
BaseMessages.getString( PKG, "ExcelInputMeta.TrimType.Left" ),
BaseMessages.getString( PKG, "ExcelInputMeta.TrimType.Right" ),
BaseMessages.getString( PKG, "ExcelInputMeta.TrimType.Both" ) };
public static final String STRING_SEPARATOR = " \t --> ";
/**
* The filenames to load or directory in case a filemask was set.
*/
@Injection( name = "FILENAME", group = "FILENAME_LINES" )
private String[] fileName;
/**
* The regular expression to use (null means: no mask)
*/
@Injection( name = "FILEMASK", group = "FILENAME_LINES" )
private String[] fileMask;
/**
* Wildcard or filemask to exclude (regular expression)
*/
@Injection( name = "EXCLUDE_FILEMASK", group = "FILENAME_LINES" )
private String[] excludeFileMask;
/**
* Array of boolean values as string, indicating if a file is required.
*/
@Injection( name = "FILE_REQUIRED", group = "FILENAME_LINES" )
private String[] fileRequired;
/**
* The fieldname that holds the name of the file
*/
private String fileField;
/**
* The names of the sheets to load. Null means: all sheets...
*/
@Injection( name = "SHEET_NAME", group = "SHEETS" )
private String[] sheetName;
/**
* The row-nr where we start processing.
*/
@Injection( name = "SHEET_START_ROW", group = "SHEETS" )
private int[] startRow;
/**
* The column-nr where we start processing.
*/
@Injection( name = "SHEET_START_COL", group = "SHEETS" )
private int[] startColumn;
/**
* The fieldname that holds the name of the sheet
*/
private String sheetField;
/**
* The cell-range starts with a header-row
*/
private boolean startsWithHeader;
/**
* Stop reading when you hit an empty row.
*/
private boolean stopOnEmpty;
/**
* Avoid empty rows in the result.
*/
private boolean ignoreEmptyRows;
/**
* The fieldname containing the row number. An empty (null) value means that no row number is included in the output.
* This is the rownumber of all written rows (not the row in the sheet).
*/
private String rowNumberField;
/**
* The fieldname containing the sheet row number. An empty (null) value means that no sheet row number is included in
* the output. Sheet row number is the row number in the sheet.
*/
private String sheetRowNumberField;
/**
* The maximum number of rows that this step writes to the next step.
*/
private long rowLimit;
/**
* The fields to read in the range. Note: the number of columns in the range has to match field.length
*/
@InjectionDeep
private ExcelInputField[] field;
/**
* Strict types : will generate erros
*/
private boolean strictTypes;
/**
* Ignore error : turn into warnings
*/
private boolean errorIgnored;
/**
* If error line are skipped, you can replay without introducing doubles.
*/
private boolean errorLineSkipped;
/**
* The directory that will contain warning files
*/
private String warningFilesDestinationDirectory;
/**
* The extension of warning files
*/
private String warningFilesExtension;
/**
* The directory that will contain error files
*/
private String errorFilesDestinationDirectory;
/**
* The extension of error files
*/
private String errorFilesExtension;
/**
* The directory that will contain line number files
*/
private String lineNumberFilesDestinationDirectory;
/**
* The extension of line number files
*/
private String lineNumberFilesExtension;
/**
* Are we accepting filenames in input rows?
*/
private boolean acceptingFilenames;
/**
* The field in which the filename is placed
*/
private String acceptingField;
/**
* The stepname to accept filenames from
*/
private String acceptingStepName;
/**
* Array of boolean values as string, indicating if we need to fetch sub folders.
*/
@Injection( name = "INCLUDE_SUBFOLDERS", group = "FILENAME_LINES" )
private String[] includeSubFolders;
/**
* The step to accept filenames from
*/
private StepMeta acceptingStep;
/**
* The encoding to use for reading: null or empty string means system default encoding
*/
private String encoding;
/**
* The add filenames to result filenames flag
*/
private boolean isaddresult;
/**
* Additional fields
**/
private String shortFileFieldName;
private String pathFieldName;
private String hiddenFieldName;
private String lastModificationTimeFieldName;
private String uriNameFieldName;
private String rootUriNameFieldName;
private String extensionFieldName;
private String sizeFieldName;
@Injection( name = "SPREADSHEET_TYPE" )
private SpreadSheetType spreadSheetType;
private String password;
public ExcelInputMeta() {
super(); // allocate BaseStepMeta
}
/**
* @return Returns the shortFileFieldName.
*/
public String getShortFileNameField() {
return shortFileFieldName;
}
/**
* @param field The shortFileFieldName to set.
*/
public void setShortFileNameField( String field ) {
shortFileFieldName = field;
}
public String getPassword() {
return password;
}
public void setPassword( String password ) {
this.password = password;
}
/**
* @return Returns the pathFieldName.
*/
public String getPathField() {
return pathFieldName;
}
/**
* @param field The pathFieldName to set.
*/
public void setPathField( String field ) {
this.pathFieldName = field;
}
/**
* @return Returns the hiddenFieldName.
*/
public String isHiddenField() {
return hiddenFieldName;
}
/**
* @param field The hiddenFieldName to set.
*/
public void setIsHiddenField( String field ) {
hiddenFieldName = field;
}
/**
* @return Returns the lastModificationTimeFieldName.
*/
public String getLastModificationDateField() {
return lastModificationTimeFieldName;
}
/**
* @param field The lastModificationTimeFieldName to set.
*/
public void setLastModificationDateField( String field ) {
lastModificationTimeFieldName = field;
}
/**
* @return Returns the uriNameFieldName.
*/
public String getUriField() {
return uriNameFieldName;
}
/**
* @param field The uriNameFieldName to set.
*/
public void setUriField( String field ) {
uriNameFieldName = field;
}
/**
* @return Returns the uriNameFieldName.
*/
public String getRootUriField() {
return rootUriNameFieldName;
}
/**
* @param field The rootUriNameFieldName to set.
*/
public void setRootUriField( String field ) {
rootUriNameFieldName = field;
}
/**
* @return Returns the extensionFieldName.
*/
public String getExtensionField() {
return extensionFieldName;
}
/**
* @param field The extensionFieldName to set.
*/
public void setExtensionField( String field ) {
extensionFieldName = field;
}
/**
* @return Returns the sizeFieldName.
*/
public String getSizeField() {
return sizeFieldName;
}
/**
* @param field The sizeFieldName to set.
*/
public void setSizeField( String field ) {
sizeFieldName = field;
}
/**
* @return Returns the fieldLength.
*/
public ExcelInputField[] getField() {
return field;
}
/**
* @param fields The excel input fields to set.
*/
public void setField( ExcelInputField[] fields ) {
this.field = fields;
}
/**
* @return Returns the fileField.
*/
public String getFileField() {
return fileField;
}
/**
* @param fileField The fileField to set.
*/
public void setFileField( String fileField ) {
this.fileField = fileField;
}
/**
* @return Returns the fileMask.
*/
public String[] getFileMask() {
return fileMask;
}
/**
* @param fileMask The fileMask to set.
*/
public void setFileMask( String[] fileMask ) {
this.fileMask = fileMask;
}
/**
* @return Returns the excludeFileMask. Deprecated due to typo
*/
@Deprecated
public String[] getExludeFileMask() {
return getExcludeFileMask();
}
/**
* @return Returns the excludeFileMask.
*/
public String[] getExcludeFileMask() {
return excludeFileMask;
}
/**
* @param excludeFileMask The excludeFileMask to set.
*/
public void setExcludeFileMask( String[] excludeFileMask ) {
this.excludeFileMask = excludeFileMask;
}
public String[] getIncludeSubFolders() {
return includeSubFolders;
}
public void setIncludeSubFolders( String[] includeSubFoldersin ) {
if ( includeSubFoldersin != null ) {
includeSubFolders = new String[ includeSubFoldersin.length ];
for ( int i = 0; i < includeSubFoldersin.length && i < includeSubFolders.length; i++ ) {
this.includeSubFolders[ i ] = getRequiredFilesCode( includeSubFoldersin[ i ] );
}
} else {
includeSubFolders = new String[ 0 ];
}
}
public String getRequiredFilesCode( String tt ) {
if ( tt == null ) {
return RequiredFilesCode[ 0 ];
}
if ( tt.equals( RequiredFilesDesc[ 1 ] ) ) {
return RequiredFilesCode[ 1 ];
} else {
return RequiredFilesCode[ 0 ];
}
}
public String getRequiredFilesDesc( String tt ) {
if ( tt == null ) {
return RequiredFilesDesc[ 0 ];
}
if ( tt.equals( RequiredFilesCode[ 1 ] ) ) {
return RequiredFilesDesc[ 1 ];
} else {
return RequiredFilesDesc[ 0 ];
}
}
/**
* @return Returns the fileName.
*/
public String[] getFileName() {
return fileName;
}
/**
* @param fileName The fileName to set.
*/
public void setFileName( String[] fileName ) {
this.fileName = fileName;
}
/**
* @return Returns the ignoreEmptyRows.
*/
public boolean ignoreEmptyRows() {
return ignoreEmptyRows;
}
/**
* @param ignoreEmptyRows The ignoreEmptyRows to set.
*/
public void setIgnoreEmptyRows( boolean ignoreEmptyRows ) {
this.ignoreEmptyRows = ignoreEmptyRows;
}
/**
* @return Returns the rowLimit.
*/
public long getRowLimit() {
return rowLimit;
}
/**
* @param rowLimit The rowLimit to set.
*/
public void setRowLimit( long rowLimit ) {
this.rowLimit = rowLimit;
}
/**
* @return Returns the rowNumberField.
*/
public String getRowNumberField() {
return rowNumberField;
}
/**
* @param rowNumberField The rowNumberField to set.
*/
public void setRowNumberField( String rowNumberField ) {
this.rowNumberField = rowNumberField;
}
/**
* @return Returns the sheetRowNumberField.
*/
public String getSheetRowNumberField() {
return sheetRowNumberField;
}
/**
* @param rowNumberField The rowNumberField to set.
*/
public void setSheetRowNumberField( String rowNumberField ) {
this.sheetRowNumberField = rowNumberField;
}
/**
* @return Returns the sheetField.
*/
public String getSheetField() {
return sheetField;
}
/**
* @param sheetField The sheetField to set.
*/
public void setSheetField( String sheetField ) {
this.sheetField = sheetField;
}
/**
* @return Returns the sheetName.
*/
public String[] getSheetName() {
return sheetName;
}
/**
* @param sheetName The sheetName to set.
*/
public void setSheetName( String[] sheetName ) {
this.sheetName = sheetName;
}
/**
* @return Returns the startColumn.
*/
public int[] getStartColumn() {
return startColumn;
}
/**
* @param startColumn The startColumn to set.
*/
public void setStartColumn( int[] startColumn ) {
this.startColumn = startColumn;
}
/**
* @return Returns the startRow.
*/
public int[] getStartRow() {
return startRow;
}
/**
* @param startRow The startRow to set.
*/
public void setStartRow( int[] startRow ) {
this.startRow = startRow;
}
/**
* @return Returns the startsWithHeader.
*/
public boolean startsWithHeader() {
return startsWithHeader;
}
/**
* @param startsWithHeader The startsWithHeader to set.
*/
public void setStartsWithHeader( boolean startsWithHeader ) {
this.startsWithHeader = startsWithHeader;
}
/**
* @return Returns the stopOnEmpty.
*/
public boolean stopOnEmpty() {
return stopOnEmpty;
}
/**
* @param stopOnEmpty The stopOnEmpty to set.
*/
public void setStopOnEmpty( boolean stopOnEmpty ) {
this.stopOnEmpty = stopOnEmpty;
}
@Override
public void loadXML( Node stepnode, List databases, IMetaStore metaStore ) throws KettleXMLException {
readData( stepnode );
}
@Override
public Object clone() {
ExcelInputMeta retval = (ExcelInputMeta) super.clone();
normilizeAllocation();
int nrfiles = fileName.length;
int nrsheets = sheetName.length;
int nrfields = field.length;
retval.allocate( nrfiles, nrsheets, nrfields );
for ( int i = 0; i < nrfields; i++ ) {
retval.field[ i ] = (ExcelInputField) field[ i ].clone();
}
System.arraycopy( fileName, 0, retval.fileName, 0, nrfiles );
System.arraycopy( fileMask, 0, retval.fileMask, 0, nrfiles );
System.arraycopy( excludeFileMask, 0, retval.excludeFileMask, 0, nrfiles );
System.arraycopy( fileRequired, 0, retval.fileRequired, 0, nrfiles );
System.arraycopy( includeSubFolders, 0, retval.includeSubFolders, 0, nrfiles );
System.arraycopy( sheetName, 0, retval.sheetName, 0, nrsheets );
System.arraycopy( startColumn, 0, retval.startColumn, 0, nrsheets );
System.arraycopy( startRow, 0, retval.startRow, 0, nrsheets );
return retval;
}
private void readData( Node stepnode ) throws KettleXMLException {
try {
startsWithHeader = YES.equalsIgnoreCase( XMLHandler.getTagValue( stepnode, "header" ) );
String nempty = XMLHandler.getTagValue( stepnode, "noempty" );
ignoreEmptyRows = YES.equalsIgnoreCase( nempty ) || nempty == null;
String soempty = XMLHandler.getTagValue( stepnode, "stoponempty" );
stopOnEmpty = YES.equalsIgnoreCase( soempty ) || nempty == null;
sheetRowNumberField = XMLHandler.getTagValue( stepnode, "sheetrownumfield" );
rowNumberField = XMLHandler.getTagValue( stepnode, "rownum_field" );
rowNumberField = XMLHandler.getTagValue( stepnode, "rownumfield" );
rowLimit = Const.toLong( XMLHandler.getTagValue( stepnode, "limit" ), 0 );
encoding = XMLHandler.getTagValue( stepnode, "encoding" );
String addToResult = XMLHandler.getTagValue( stepnode, "add_to_result_filenames" );
if ( Utils.isEmpty( addToResult ) ) {
isaddresult = true;
} else {
isaddresult = "Y".equalsIgnoreCase( addToResult );
}
sheetField = XMLHandler.getTagValue( stepnode, "sheetfield" );
fileField = XMLHandler.getTagValue( stepnode, "filefield" );
acceptingFilenames = YES.equalsIgnoreCase( XMLHandler.getTagValue( stepnode, "accept_filenames" ) );
acceptingField = XMLHandler.getTagValue( stepnode, "accept_field" );
acceptingStepName = XMLHandler.getTagValue( stepnode, "accept_stepname" );
Node filenode = XMLHandler.getSubNode( stepnode, "file" );
Node sheetsnode = XMLHandler.getSubNode( stepnode, "sheets" );
Node fields = XMLHandler.getSubNode( stepnode, "fields" );
int nrfiles = XMLHandler.countNodes( filenode, "name" );
int nrsheets = XMLHandler.countNodes( sheetsnode, "sheet" );
int nrfields = XMLHandler.countNodes( fields, "field" );
allocate( nrfiles, nrsheets, nrfields );
for ( int i = 0; i < nrfiles; i++ ) {
Node filenamenode = XMLHandler.getSubNodeByNr( filenode, "name", i );
Node filemasknode = XMLHandler.getSubNodeByNr( filenode, "filemask", i );
Node excludefilemasknode = XMLHandler.getSubNodeByNr( filenode, "exclude_filemask", i );
Node fileRequirednode = XMLHandler.getSubNodeByNr( filenode, "file_required", i );
Node includeSubFoldersnode = XMLHandler.getSubNodeByNr( filenode, "include_subfolders", i );
fileName[ i ] = XMLHandler.getNodeValue( filenamenode );
fileMask[ i ] = XMLHandler.getNodeValue( filemasknode );
excludeFileMask[ i ] = XMLHandler.getNodeValue( excludefilemasknode );
fileRequired[ i ] = XMLHandler.getNodeValue( fileRequirednode );
includeSubFolders[ i ] = XMLHandler.getNodeValue( includeSubFoldersnode );
}
for ( int i = 0; i < nrfields; i++ ) {
Node fnode = XMLHandler.getSubNodeByNr( fields, "field", i );
field[ i ] = new ExcelInputField();
field[ i ].setName( XMLHandler.getTagValue( fnode, "name" ) );
field[ i ].setType( ValueMetaFactory.getIdForValueMeta( XMLHandler.getTagValue( fnode, "type" ) ) );
field[ i ].setLength( Const.toInt( XMLHandler.getTagValue( fnode, "length" ), -1 ) );
field[ i ].setPrecision( Const.toInt( XMLHandler.getTagValue( fnode, "precision" ), -1 ) );
String srepeat = XMLHandler.getTagValue( fnode, "repeat" );
field[ i ].setTrimType( getTrimTypeByCode( XMLHandler.getTagValue( fnode, "trim_type" ) ) );
if ( srepeat != null ) {
field[ i ].setRepeated( YES.equalsIgnoreCase( srepeat ) );
} else {
field[ i ].setRepeated( false );
}
field[ i ].setFormat( XMLHandler.getTagValue( fnode, "format" ) );
field[ i ].setCurrencySymbol( XMLHandler.getTagValue( fnode, "currency" ) );
field[ i ].setDecimalSymbol( XMLHandler.getTagValue( fnode, "decimal" ) );
field[ i ].setGroupSymbol( XMLHandler.getTagValue( fnode, "group" ) );
}
for ( int i = 0; i < nrsheets; i++ ) {
Node snode = XMLHandler.getSubNodeByNr( sheetsnode, "sheet", i );
sheetName[ i ] = XMLHandler.getTagValue( snode, "name" );
startRow[ i ] = Const.toInt( XMLHandler.getTagValue( snode, "startrow" ), 0 );
startColumn[ i ] = Const.toInt( XMLHandler.getTagValue( snode, "startcol" ), 0 );
}
strictTypes = YES.equalsIgnoreCase( XMLHandler.getTagValue( stepnode, "strict_types" ) );
errorIgnored = YES.equalsIgnoreCase( XMLHandler.getTagValue( stepnode, "error_ignored" ) );
errorLineSkipped = YES.equalsIgnoreCase( XMLHandler.getTagValue( stepnode, "error_line_skipped" ) );
warningFilesDestinationDirectory = XMLHandler.getTagValue( stepnode, "bad_line_files_destination_directory" );
warningFilesExtension = XMLHandler.getTagValue( stepnode, "bad_line_files_extension" );
errorFilesDestinationDirectory = XMLHandler.getTagValue( stepnode, "error_line_files_destination_directory" );
errorFilesExtension = XMLHandler.getTagValue( stepnode, "error_line_files_extension" );
lineNumberFilesDestinationDirectory =
XMLHandler.getTagValue( stepnode, "line_number_files_destination_directory" );
lineNumberFilesExtension = XMLHandler.getTagValue( stepnode, "line_number_files_extension" );
shortFileFieldName = XMLHandler.getTagValue( stepnode, "shortFileFieldName" );
pathFieldName = XMLHandler.getTagValue( stepnode, "pathFieldName" );
hiddenFieldName = XMLHandler.getTagValue( stepnode, "hiddenFieldName" );
lastModificationTimeFieldName = XMLHandler.getTagValue( stepnode, "lastModificationTimeFieldName" );
uriNameFieldName = XMLHandler.getTagValue( stepnode, "uriNameFieldName" );
rootUriNameFieldName = XMLHandler.getTagValue( stepnode, "rootUriNameFieldName" );
extensionFieldName = XMLHandler.getTagValue( stepnode, "extensionFieldName" );
sizeFieldName = XMLHandler.getTagValue( stepnode, "sizeFieldName" );
password = Encr.decryptPasswordOptionallyEncrypted( XMLHandler.getTagValue( stepnode, "password" ) );
try {
spreadSheetType = SpreadSheetType.valueOf( XMLHandler.getTagValue( stepnode, "spreadsheet_type" ) );
} catch ( Exception e ) {
spreadSheetType = SpreadSheetType.JXL;
}
} catch ( Exception e ) {
throw new KettleXMLException( "Unable to read step information from XML", e );
}
}
public String[] normilizeArray( String[] array, int length ) {
String[] newArray = new String[ length ];
if ( array != null ) {
if ( array.length <= length ) {
System.arraycopy( array, 0, newArray, 0, array.length );
} else {
System.arraycopy( array, 0, newArray, 0, length );
}
}
return newArray;
}
public int[] normilizeArray( int[] array, int length ) {
int[] newArray = new int[ length ];
if ( array != null ) {
if ( array.length <= length ) {
System.arraycopy( array, 0, newArray, 0, array.length );
} else {
System.arraycopy( array, 0, newArray, 0, length );
}
}
return newArray;
}
public void normilizeAllocation() {
int nrfiles = 0;
int nrsheets = 0;
if ( fileName != null ) {
nrfiles = fileName.length;
} else {
fileName = new String[ 0 ];
}
if ( sheetName != null ) {
nrsheets = sheetName.length;
} else {
sheetName = new String[ 0 ];
}
if ( field == null ) {
field = new ExcelInputField[ 0 ];
}
fileMask = normilizeArray( fileMask, nrfiles );
excludeFileMask = normilizeArray( excludeFileMask, nrfiles );
fileRequired = normilizeArray( fileRequired, nrfiles );
includeSubFolders = normilizeArray( includeSubFolders, nrfiles );
startRow = normilizeArray( startRow, nrsheets );
startColumn = normilizeArray( startColumn, nrsheets );
}
public void allocate( int nrfiles, int nrsheets, int nrfields ) {
allocateFiles( nrfiles );
sheetName = new String[ nrsheets ];
startRow = new int[ nrsheets ];
startColumn = new int[ nrsheets ];
field = new ExcelInputField[ nrfields ];
}
public void allocateFiles( int nrfiles ) {
fileName = new String[ nrfiles ];
fileMask = new String[ nrfiles ];
excludeFileMask = new String[ nrfiles ];
fileRequired = new String[ nrfiles ];
includeSubFolders = new String[ nrfiles ];
}
@Override
public void setDefault() {
startsWithHeader = true;
ignoreEmptyRows = true;
rowNumberField = StringUtil.EMPTY_STRING;
sheetRowNumberField = StringUtil.EMPTY_STRING;
isaddresult = true;
int nrfiles = 0;
int nrfields = 0;
int nrsheets = 0;
allocate( nrfiles, nrsheets, nrfields );
rowLimit = 0L;
strictTypes = false;
errorIgnored = false;
errorLineSkipped = false;
warningFilesDestinationDirectory = null;
warningFilesExtension = "warning";
errorFilesDestinationDirectory = null;
errorFilesExtension = "error";
lineNumberFilesDestinationDirectory = null;
lineNumberFilesExtension = "line";
spreadSheetType = SpreadSheetType.JXL; // default.
}
@Override
public void getFields( RowMetaInterface row, String name, RowMetaInterface[] info, StepMeta nextStep,
VariableSpace space, Repository repository, IMetaStore metaStore ) throws KettleStepException {
for ( int i = 0; i < field.length; i++ ) {
int type = field[ i ].getType();
if ( type == ValueMetaInterface.TYPE_NONE ) {
type = ValueMetaInterface.TYPE_STRING;
}
try {
ValueMetaInterface v = ValueMetaFactory.createValueMeta( field[ i ].getName(), type );
v.setLength( field[ i ].getLength() );
v.setPrecision( field[ i ].getPrecision() );
v.setOrigin( name );
v.setConversionMask( field[ i ].getFormat() );
v.setDecimalSymbol( field[ i ].getDecimalSymbol() );
v.setGroupingSymbol( field[ i ].getGroupSymbol() );
v.setCurrencySymbol( field[ i ].getCurrencySymbol() );
row.addValueMeta( v );
} catch ( Exception e ) {
throw new KettleStepException( e );
}
}
if ( fileField != null && fileField.length() > 0 ) {
ValueMetaInterface v = new ValueMetaString( fileField );
v.setLength( 250 );
v.setPrecision( -1 );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( sheetField != null && sheetField.length() > 0 ) {
ValueMetaInterface v = new ValueMetaString( sheetField );
v.setLength( 250 );
v.setPrecision( -1 );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( sheetRowNumberField != null && sheetRowNumberField.length() > 0 ) {
ValueMetaInterface v = new ValueMetaInteger( sheetRowNumberField );
v.setLength( ValueMetaInterface.DEFAULT_INTEGER_LENGTH, 0 );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( rowNumberField != null && rowNumberField.length() > 0 ) {
ValueMetaInterface v = new ValueMetaInteger( rowNumberField );
v.setLength( ValueMetaInterface.DEFAULT_INTEGER_LENGTH, 0 );
v.setOrigin( name );
row.addValueMeta( v );
}
// Add additional fields
if ( getShortFileNameField() != null && getShortFileNameField().length() > 0 ) {
ValueMetaInterface v =
new ValueMetaString( space.environmentSubstitute( getShortFileNameField() ) );
v.setLength( 100, -1 );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( getExtensionField() != null && getExtensionField().length() > 0 ) {
ValueMetaInterface v =
new ValueMetaString( space.environmentSubstitute( getExtensionField() ) );
v.setLength( 100, -1 );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( getPathField() != null && getPathField().length() > 0 ) {
ValueMetaInterface v =
new ValueMetaString( space.environmentSubstitute( getPathField() ) );
v.setLength( 100, -1 );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( getSizeField() != null && getSizeField().length() > 0 ) {
ValueMetaInterface v =
new ValueMetaInteger( space.environmentSubstitute( getSizeField() ) );
v.setOrigin( name );
v.setLength( 9 );
row.addValueMeta( v );
}
if ( isHiddenField() != null && isHiddenField().length() > 0 ) {
ValueMetaInterface v =
new ValueMetaBoolean( space.environmentSubstitute( isHiddenField() ) );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( getLastModificationDateField() != null && getLastModificationDateField().length() > 0 ) {
ValueMetaInterface v =
new ValueMetaDate(
space.environmentSubstitute( getLastModificationDateField() ) );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( getUriField() != null && getUriField().length() > 0 ) {
ValueMetaInterface v =
new ValueMetaString( space.environmentSubstitute( getUriField() ) );
v.setLength( 100, -1 );
v.setOrigin( name );
row.addValueMeta( v );
}
if ( getRootUriField() != null && getRootUriField().length() > 0 ) {
ValueMetaInterface v =
new ValueMetaString( space.environmentSubstitute( getRootUriField() ) );
v.setLength( 100, -1 );
v.setOrigin( name );
row.addValueMeta( v );
}
}
@Override
public String getXML() {
StringBuilder retval = new StringBuilder( 1024 );
normilizeAllocation();
retval.append( " " ).append( XMLHandler.addTagValue( "header", startsWithHeader ) );
retval.append( " " ).append( XMLHandler.addTagValue( "noempty", ignoreEmptyRows ) );
retval.append( " " ).append( XMLHandler.addTagValue( "stoponempty", stopOnEmpty ) );
retval.append( " " ).append( XMLHandler.addTagValue( "filefield", fileField ) );
retval.append( " " ).append( XMLHandler.addTagValue( "sheetfield", sheetField ) );
retval.append( " " ).append( XMLHandler.addTagValue( "sheetrownumfield", sheetRowNumberField ) );
retval.append( " " ).append( XMLHandler.addTagValue( "rownumfield", rowNumberField ) );
retval.append( " " ).append( XMLHandler.addTagValue( "sheetfield", sheetField ) );
retval.append( " " ).append( XMLHandler.addTagValue( "filefield", fileField ) );
retval.append( " " ).append( XMLHandler.addTagValue( "limit", rowLimit ) );
retval.append( " " ).append( XMLHandler.addTagValue( "encoding", encoding ) );
retval.append( " " + XMLHandler.addTagValue( "add_to_result_filenames", isaddresult ) );
retval.append( " " ).append( XMLHandler.addTagValue( "accept_filenames", acceptingFilenames ) );
retval.append( " " ).append( XMLHandler.addTagValue( "accept_field", acceptingField ) );
retval.append( " " ).append(
XMLHandler.addTagValue( "accept_stepname",
( acceptingStep != null ? acceptingStep.getName() : StringUtil.EMPTY_STRING ) ) );
/*
* Describe the files to read
*/
retval.append( " " ).append( Const.CR );
for ( int i = 0; i < fileName.length; i++ ) {
retval.append( " " ).append( XMLHandler.addTagValue( "name", fileName[ i ] ) );
retval.append( " " ).append( XMLHandler.addTagValue( "filemask", fileMask[ i ] ) );
retval.append( " " ).append( XMLHandler.addTagValue( "exclude_filemask", excludeFileMask[ i ] ) );
retval.append( " " ).append( XMLHandler.addTagValue( "file_required", fileRequired[ i ] ) );
retval.append( " " ).append( XMLHandler.addTagValue( "include_subfolders", includeSubFolders[ i ] ) );
}
retval.append( " " ).append( Const.CR );
/*
* Describe the fields to read
*/
retval.append( " " ).append( Const.CR );
for ( int i = 0; i < field.length; i++ ) {
retval.append( " " ).append( Const.CR );
retval.append( " " ).append( XMLHandler.addTagValue( "name", field[ i ].getName() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "type", field[ i ].getTypeDesc() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "length", field[ i ].getLength() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "precision", field[ i ].getPrecision() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "trim_type", field[ i ].getTrimTypeCode() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "repeat", field[ i ].isRepeated() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "format", field[ i ].getFormat() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "currency", field[ i ].getCurrencySymbol() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "decimal", field[ i ].getDecimalSymbol() ) );
retval.append( " " ).append( XMLHandler.addTagValue( "group", field[ i ].getGroupSymbol() ) );
retval.append( " " ).append( Const.CR );
}
retval.append( " " ).append( Const.CR );
/*
* Describe the sheets to load...
*/
retval.append( " " ).append( Const.CR );
for ( int i = 0; i < sheetName.length; i++ ) {
retval.append( " " ).append( Const.CR );
retval.append( " " ).append( XMLHandler.addTagValue( "name", sheetName[ i ] ) );
retval.append( " " ).append( XMLHandler.addTagValue( "startrow", startRow[ i ] ) );
retval.append( " " ).append( XMLHandler.addTagValue( "startcol", startColumn[ i ] ) );
retval.append( " " ).append( Const.CR );
}
retval.append( " " ).append( Const.CR );
// ERROR HANDLING
retval.append( " " ).append( XMLHandler.addTagValue( "strict_types", strictTypes ) );
retval.append( " " ).append( XMLHandler.addTagValue( "error_ignored", errorIgnored ) );
retval.append( " " ).append( XMLHandler.addTagValue( "error_line_skipped", errorLineSkipped ) );
retval.append( " " ).append(
XMLHandler.addTagValue( "bad_line_files_destination_directory", warningFilesDestinationDirectory ) );
retval.append( " " ).append( XMLHandler.addTagValue( "bad_line_files_extension", warningFilesExtension ) );
retval.append( " " ).append(
XMLHandler.addTagValue( "error_line_files_destination_directory", errorFilesDestinationDirectory ) );
retval.append( " " ).append( XMLHandler.addTagValue( "error_line_files_extension", errorFilesExtension ) );
retval.append( " " ).append(
XMLHandler.addTagValue( "line_number_files_destination_directory", lineNumberFilesDestinationDirectory ) );
retval.append( " " ).append(
XMLHandler.addTagValue( "line_number_files_extension", lineNumberFilesExtension ) );
retval.append( " " ).append( XMLHandler.addTagValue( "shortFileFieldName", shortFileFieldName ) );
retval.append( " " ).append( XMLHandler.addTagValue( "pathFieldName", pathFieldName ) );
retval.append( " " ).append( XMLHandler.addTagValue( "hiddenFieldName", hiddenFieldName ) );
retval.append( " " ).append(
XMLHandler.addTagValue( "lastModificationTimeFieldName", lastModificationTimeFieldName ) );
retval.append( " " ).append( XMLHandler.addTagValue( "uriNameFieldName", uriNameFieldName ) );
retval.append( " " ).append( XMLHandler.addTagValue( "rootUriNameFieldName", rootUriNameFieldName ) );
retval.append( " " ).append( XMLHandler.addTagValue( "extensionFieldName", extensionFieldName ) );
retval.append( " " ).append( XMLHandler.addTagValue( "sizeFieldName", sizeFieldName ) );
retval.append( " " ).append( XMLHandler.addTagValue( "spreadsheet_type",
( spreadSheetType != null ? spreadSheetType.toString() : StringUtil.EMPTY_STRING ) ) );
retval.append( " " )
.append( XMLHandler.addTagValue( "password", Encr.encryptPasswordIfNotUsingVariables( password ) ) );
return retval.toString();
}
@Override
public void readRep( Repository rep, IMetaStore metaStore, ObjectId id_step, List databases )
throws KettleException {
try {
startsWithHeader = rep.getStepAttributeBoolean( id_step, "header" );
ignoreEmptyRows = rep.getStepAttributeBoolean( id_step, "noempty" );
stopOnEmpty = rep.getStepAttributeBoolean( id_step, "stoponempty" );
fileField = rep.getStepAttributeString( id_step, "filefield" );
sheetField = rep.getStepAttributeString( id_step, "sheetfield" );
sheetRowNumberField = rep.getStepAttributeString( id_step, "sheetrownumfield" );
rowNumberField = rep.getStepAttributeString( id_step, "rownumfield" );
rowLimit = (int) rep.getStepAttributeInteger( id_step, "limit" );
encoding = rep.getStepAttributeString( id_step, "encoding" );
String addToResult = rep.getStepAttributeString( id_step, "add_to_result_filenames" );
if ( Utils.isEmpty( addToResult ) ) {
isaddresult = true;
} else {
isaddresult = rep.getStepAttributeBoolean( id_step, "add_to_result_filenames" );
}
acceptingFilenames = rep.getStepAttributeBoolean( id_step, "accept_filenames" );
acceptingField = rep.getStepAttributeString( id_step, "accept_field" );
acceptingStepName = rep.getStepAttributeString( id_step, "accept_stepname" );
int nrfiles = rep.countNrStepAttributes( id_step, "file_name" );
int nrsheets = rep.countNrStepAttributes( id_step, "sheet_name" );
int nrfields = rep.countNrStepAttributes( id_step, "field_name" );
allocate( nrfiles, nrsheets, nrfields );
// System.out.println("Counted "+nrfiles+" files to read and "+nrsheets+" sheets, "+nrfields+" fields.");
for ( int i = 0; i < nrfiles; i++ ) {
fileName[ i ] = rep.getStepAttributeString( id_step, i, "file_name" );
fileMask[ i ] = rep.getStepAttributeString( id_step, i, "file_mask" );
excludeFileMask[ i ] = rep.getStepAttributeString( id_step, i, "exclude_file_mask" );
fileRequired[ i ] = rep.getStepAttributeString( id_step, i, "file_required" );
if ( !YES.equalsIgnoreCase( fileRequired[ i ] ) ) {
fileRequired[ i ] = NO;
}
includeSubFolders[ i ] = rep.getStepAttributeString( id_step, i, "include_subfolders" );
if ( !YES.equalsIgnoreCase( includeSubFolders[ i ] ) ) {
includeSubFolders[ i ] = NO;
}
}
for ( int i = 0; i < nrsheets; i++ ) {
sheetName[ i ] = rep.getStepAttributeString( id_step, i, "sheet_name" );
startRow[ i ] = (int) rep.getStepAttributeInteger( id_step, i, "sheet_startrow" );
startColumn[ i ] = (int) rep.getStepAttributeInteger( id_step, i, "sheet_startcol" );
}
for ( int i = 0; i < nrfields; i++ ) {
field[ i ] = new ExcelInputField();
field[ i ].setName( rep.getStepAttributeString( id_step, i, "field_name" ) );
field[ i ]
.setType( ValueMetaFactory.getIdForValueMeta( rep.getStepAttributeString( id_step, i, "field_type" ) ) );
field[ i ].setLength( (int) rep.getStepAttributeInteger( id_step, i, "field_length" ) );
field[ i ].setPrecision( (int) rep.getStepAttributeInteger( id_step, i, "field_precision" ) );
field[ i ].setTrimType( getTrimTypeByCode( rep.getStepAttributeString( id_step, i, "field_trim_type" ) ) );
field[ i ].setRepeated( rep.getStepAttributeBoolean( id_step, i, "field_repeat" ) );
field[ i ].setFormat( rep.getStepAttributeString( id_step, i, "field_format" ) );
field[ i ].setCurrencySymbol( rep.getStepAttributeString( id_step, i, "field_currency" ) );
field[ i ].setDecimalSymbol( rep.getStepAttributeString( id_step, i, "field_decimal" ) );
field[ i ].setGroupSymbol( rep.getStepAttributeString( id_step, i, "field_group" ) );
}
strictTypes = rep.getStepAttributeBoolean( id_step, 0, "strict_types", false );
errorIgnored = rep.getStepAttributeBoolean( id_step, 0, "error_ignored", false );
errorLineSkipped = rep.getStepAttributeBoolean( id_step, 0, "error_line_skipped", false );
warningFilesDestinationDirectory = rep.getStepAttributeString( id_step, "bad_line_files_dest_dir" );
warningFilesExtension = rep.getStepAttributeString( id_step, "bad_line_files_ext" );
errorFilesDestinationDirectory = rep.getStepAttributeString( id_step, "error_line_files_dest_dir" );
errorFilesExtension = rep.getStepAttributeString( id_step, "error_line_files_ext" );
lineNumberFilesDestinationDirectory = rep.getStepAttributeString( id_step, "line_number_files_dest_dir" );
lineNumberFilesExtension = rep.getStepAttributeString( id_step, "line_number_files_ext" );
shortFileFieldName = rep.getStepAttributeString( id_step, "shortFileFieldName" );
pathFieldName = rep.getStepAttributeString( id_step, "pathFieldName" );
hiddenFieldName = rep.getStepAttributeString( id_step, "hiddenFieldName" );
lastModificationTimeFieldName = rep.getStepAttributeString( id_step, "lastModificationTimeFieldName" );
rootUriNameFieldName = rep.getStepAttributeString( id_step, "rootUriNameFieldName" );
uriNameFieldName = rep.getStepAttributeString( id_step, "uriNameFieldName" );
extensionFieldName = rep.getStepAttributeString( id_step, "extensionFieldName" );
sizeFieldName = rep.getStepAttributeString( id_step, "sizeFieldName" );
password = Encr.decryptPasswordOptionallyEncrypted( rep.getStepAttributeString( id_step, "password" ) );
try {
spreadSheetType = SpreadSheetType.valueOf( rep.getStepAttributeString( id_step, "spreadsheet_type" ) );
} catch ( Exception e ) {
spreadSheetType = SpreadSheetType.JXL;
}
} catch ( Exception e ) {
throw new KettleException( "Unexpected error reading step information from the repository", e );
}
}
@Override
public void saveRep( Repository rep, IMetaStore metaStore, ObjectId id_transformation, ObjectId id_step )
throws KettleException {
try {
normilizeAllocation();
rep.saveStepAttribute( id_transformation, id_step, "header", startsWithHeader );
rep.saveStepAttribute( id_transformation, id_step, "noempty", ignoreEmptyRows );
rep.saveStepAttribute( id_transformation, id_step, "stoponempty", stopOnEmpty );
rep.saveStepAttribute( id_transformation, id_step, "filefield", fileField );
rep.saveStepAttribute( id_transformation, id_step, "sheetfield", sheetField );
rep.saveStepAttribute( id_transformation, id_step, "sheetrownumfield", sheetRowNumberField );
rep.saveStepAttribute( id_transformation, id_step, "rownumfield", rowNumberField );
rep.saveStepAttribute( id_transformation, id_step, "limit", rowLimit );
rep.saveStepAttribute( id_transformation, id_step, "encoding", encoding );
rep.saveStepAttribute( id_transformation, id_step, "add_to_result_filenames", isaddresult );
rep.saveStepAttribute( id_transformation, id_step, "accept_filenames", acceptingFilenames );
rep.saveStepAttribute( id_transformation, id_step, "accept_field", acceptingField );
rep.saveStepAttribute( id_transformation, id_step, "accept_stepname", ( acceptingStep != null
? acceptingStep.getName() : StringUtil.EMPTY_STRING ) );
for ( int i = 0; i < fileName.length; i++ ) {
rep.saveStepAttribute( id_transformation, id_step, i, "file_name", getValueOrEmptyIfNull( fileName[ i ] ) );
rep.saveStepAttribute( id_transformation, id_step, i, "file_mask", fileMask[ i ] );
rep.saveStepAttribute( id_transformation, id_step, i, "exclude_file_mask", excludeFileMask[ i ] );
rep.saveStepAttribute( id_transformation, id_step, i, "file_required", fileRequired[ i ] );
rep.saveStepAttribute( id_transformation, id_step, i, "include_subfolders", includeSubFolders[ i ] );
}
for ( int i = 0; i < sheetName.length; i++ ) {
rep.saveStepAttribute( id_transformation, id_step, i, "sheet_name", getValueOrEmptyIfNull( sheetName[ i ] ) );
rep.saveStepAttribute( id_transformation, id_step, i, "sheet_startrow", startRow[ i ] );
rep.saveStepAttribute( id_transformation, id_step, i, "sheet_startcol", startColumn[ i ] );
}
for ( int i = 0; i < field.length; i++ ) {
rep.saveStepAttribute( id_transformation, id_step, i, "field_name",
getValueOrEmptyIfNull( field[ i ].getName() ) );
rep.saveStepAttribute( id_transformation, id_step, i, "field_type", field[ i ].getTypeDesc() );
rep.saveStepAttribute( id_transformation, id_step, i, "field_length", field[ i ].getLength() );
rep.saveStepAttribute( id_transformation, id_step, i, "field_precision", field[ i ].getPrecision() );
rep.saveStepAttribute( id_transformation, id_step, i, "field_trim_type", field[ i ].getTrimTypeCode() );
rep.saveStepAttribute( id_transformation, id_step, i, "field_repeat", field[ i ].isRepeated() );
rep.saveStepAttribute( id_transformation, id_step, i, "field_format", field[ i ].getFormat() );
rep.saveStepAttribute( id_transformation, id_step, i, "field_currency", field[ i ].getCurrencySymbol() );
rep.saveStepAttribute( id_transformation, id_step, i, "field_decimal", field[ i ].getDecimalSymbol() );
rep.saveStepAttribute( id_transformation, id_step, i, "field_group", field[ i ].getGroupSymbol() );
}
rep.saveStepAttribute( id_transformation, id_step, "strict_types", strictTypes );
rep.saveStepAttribute( id_transformation, id_step, "error_ignored", errorIgnored );
rep.saveStepAttribute( id_transformation, id_step, "error_line_skipped", errorLineSkipped );
rep.saveStepAttribute(
id_transformation, id_step, "bad_line_files_dest_dir", warningFilesDestinationDirectory );
rep.saveStepAttribute( id_transformation, id_step, "bad_line_files_ext", warningFilesExtension );
rep.saveStepAttribute(
id_transformation, id_step, "error_line_files_dest_dir", errorFilesDestinationDirectory );
rep.saveStepAttribute( id_transformation, id_step, "error_line_files_ext", errorFilesExtension );
rep.saveStepAttribute(
id_transformation, id_step, "line_number_files_dest_dir", lineNumberFilesDestinationDirectory );
rep.saveStepAttribute( id_transformation, id_step, "line_number_files_ext", lineNumberFilesExtension );
rep.saveStepAttribute( id_transformation, id_step, "shortFileFieldName", shortFileFieldName );
rep.saveStepAttribute( id_transformation, id_step, "pathFieldName", pathFieldName );
rep.saveStepAttribute( id_transformation, id_step, "hiddenFieldName", hiddenFieldName );
rep.saveStepAttribute(
id_transformation, id_step, "lastModificationTimeFieldName", lastModificationTimeFieldName );
rep.saveStepAttribute( id_transformation, id_step, "uriNameFieldName", uriNameFieldName );
rep.saveStepAttribute( id_transformation, id_step, "rootUriNameFieldName", rootUriNameFieldName );
rep.saveStepAttribute( id_transformation, id_step, "extensionFieldName", extensionFieldName );
rep.saveStepAttribute( id_transformation, id_step, "sizeFieldName", sizeFieldName );
rep.saveStepAttribute( id_transformation, id_step, "spreadsheet_type",
( spreadSheetType != null ? spreadSheetType.toString() : StringUtil.EMPTY_STRING ) );
rep.saveStepAttribute( id_transformation, id_step, "password", Encr
.encryptPasswordIfNotUsingVariables( password ) );
} catch ( Exception e ) {
throw new KettleException( "Unable to save step information to the repository for id_step=" + id_step, e );
}
}
private String getValueOrEmptyIfNull( String str ) {
return str == null ? StringUtils.EMPTY : str;
}
public static final int getTrimTypeByCode( String tt ) {
if ( tt != null ) {
for ( int i = 0; i < type_trim_code.length; i++ ) {
if ( type_trim_code[ i ].equalsIgnoreCase( tt ) ) {
return i;
}
}
}
return 0;
}
public static final int getTrimTypeByDesc( String tt ) {
if ( tt != null ) {
for ( int i = 0; i < type_trim_desc.length; i++ ) {
if ( type_trim_desc[ i ].equalsIgnoreCase( tt ) ) {
return i;
}
}
}
return 0;
}
public static final String getTrimTypeCode( int i ) {
if ( i < 0 || i >= type_trim_code.length ) {
return type_trim_code[ 0 ];
}
return type_trim_code[ i ];
}
public static final String getTrimTypeDesc( int i ) {
if ( i < 0 || i >= type_trim_desc.length ) {
return type_trim_desc[ 0 ];
}
return type_trim_desc[ i ];
}
public String[] getFilePaths( VariableSpace space ) {
normilizeAllocation();
return FileInputList.createFilePathList(
space, fileName, fileMask, excludeFileMask, fileRequired, includeSubFolderBoolean() );
}
public FileInputList getFileList( VariableSpace space ) {
normilizeAllocation();
return FileInputList.createFileList(
space, fileName, fileMask, excludeFileMask, fileRequired, includeSubFolderBoolean() );
}
private boolean[] includeSubFolderBoolean() {
normilizeAllocation();
int len = fileName.length;
boolean[] includeSubFolderBoolean = new boolean[ len ];
for ( int i = 0; i < len; i++ ) {
includeSubFolderBoolean[ i ] = YES.equalsIgnoreCase( includeSubFolders[ i ] );
}
return includeSubFolderBoolean;
}
public String getLookupStepname() {
if ( acceptingFilenames && acceptingStep != null && !Utils.isEmpty( acceptingStep.getName() ) ) {
return acceptingStep.getName();
}
return null;
}
@Override
public void searchInfoAndTargetSteps( List steps ) {
acceptingStep = StepMeta.findStep( steps, acceptingStepName );
}
public String[] getInfoSteps() {
return null;
}
@Override
public void check( List remarks, TransMeta transMeta, StepMeta stepMeta,
RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info, VariableSpace space,
Repository repository, IMetaStore metaStore ) {
CheckResult cr;
// See if we get input...
if ( input.length > 0 ) {
if ( !isAcceptingFilenames() ) {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_ERROR, BaseMessages.getString(
PKG, "ExcelInputMeta.CheckResult.NoInputError" ), stepMeta );
remarks.add( cr );
} else {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_OK, BaseMessages.getString(
PKG, "ExcelInputMeta.CheckResult.AcceptFilenamesOk" ), stepMeta );
remarks.add( cr );
}
} else {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_OK, BaseMessages.getString(
PKG, "ExcelInputMeta.CheckResult.NoInputOk" ), stepMeta );
remarks.add( cr );
}
FileInputList fileList = getFileList( transMeta );
if ( fileList.nrOfFiles() == 0 ) {
if ( !isAcceptingFilenames() ) {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_ERROR, BaseMessages.getString(
PKG, "ExcelInputMeta.CheckResult.ExpectedFilesError" ), stepMeta );
remarks.add( cr );
}
} else {
cr =
new CheckResult( CheckResultInterface.TYPE_RESULT_OK, BaseMessages.getString(
PKG, "ExcelInputMeta.CheckResult.ExpectedFilesOk", StringUtil.EMPTY_STRING + fileList.nrOfFiles() ),
stepMeta );
remarks.add( cr );
}
}
public RowMetaInterface getEmptyFields() {
RowMetaInterface row = new RowMeta();
if ( field != null ) {
for ( int i = 0; i < field.length; i++ ) {
ValueMetaInterface v;
try {
v = ValueMetaFactory.createValueMeta( field[ i ].getName(), field[ i ].getType() );
} catch ( KettlePluginException e ) {
v = new ValueMetaNone( field[ i ].getName() );
}
row.addValueMeta( v );
}
}
return row;
}
@Override
public StepInterface getStep( StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr,
TransMeta transMeta, Trans trans ) {
return new ExcelInput( stepMeta, stepDataInterface, cnr, transMeta, trans );
}
@Override
public StepDataInterface getStepData() {
return new ExcelInputData();
}
public String getWarningFilesDestinationDirectory() {
return warningFilesDestinationDirectory;
}
public void setWarningFilesDestinationDirectory( String badLineFilesDestinationDirectory ) {
this.warningFilesDestinationDirectory = badLineFilesDestinationDirectory;
}
public String getBadLineFilesExtension() {
return warningFilesExtension;
}
public void setBadLineFilesExtension( String badLineFilesExtension ) {
this.warningFilesExtension = badLineFilesExtension;
}
public boolean isErrorIgnored() {
return errorIgnored;
}
public void setErrorIgnored( boolean errorIgnored ) {
this.errorIgnored = errorIgnored;
}
public String getErrorFilesDestinationDirectory() {
return errorFilesDestinationDirectory;
}
public void setErrorFilesDestinationDirectory( String errorLineFilesDestinationDirectory ) {
this.errorFilesDestinationDirectory = errorLineFilesDestinationDirectory;
}
public String getErrorFilesExtension() {
return errorFilesExtension;
}
public void setErrorFilesExtension( String errorLineFilesExtension ) {
this.errorFilesExtension = errorLineFilesExtension;
}
public String getLineNumberFilesDestinationDirectory() {
return lineNumberFilesDestinationDirectory;
}
public void setLineNumberFilesDestinationDirectory( String lineNumberFilesDestinationDirectory ) {
this.lineNumberFilesDestinationDirectory = lineNumberFilesDestinationDirectory;
}
public String getLineNumberFilesExtension() {
return lineNumberFilesExtension;
}
public void setLineNumberFilesExtension( String lineNumberFilesExtension ) {
this.lineNumberFilesExtension = lineNumberFilesExtension;
}
public boolean isErrorLineSkipped() {
return errorLineSkipped;
}
public void setErrorLineSkipped( boolean errorLineSkipped ) {
this.errorLineSkipped = errorLineSkipped;
}
public boolean isStrictTypes() {
return strictTypes;
}
public void setStrictTypes( boolean strictTypes ) {
this.strictTypes = strictTypes;
}
public String[] getFileRequired() {
return fileRequired;
}
public void setFileRequired( String[] fileRequiredin ) {
fileRequired = new String[ fileRequiredin.length ];
for ( int i = 0; i < fileRequiredin.length && i < fileRequired.length; i++ ) {
this.fileRequired[ i ] = getRequiredFilesCode( fileRequiredin[ i ] );
}
}
/**
* @return Returns the acceptingField.
*/
public String getAcceptingField() {
return acceptingField;
}
/**
* @param acceptingField The acceptingField to set.
*/
public void setAcceptingField( String acceptingField ) {
this.acceptingField = acceptingField;
}
/**
* @return Returns the acceptingFilenames.
*/
public boolean isAcceptingFilenames() {
return acceptingFilenames;
}
/**
* @param acceptingFilenames The acceptingFilenames to set.
*/
public void setAcceptingFilenames( boolean acceptingFilenames ) {
this.acceptingFilenames = acceptingFilenames;
}
/**
* @return Returns the acceptingStep.
*/
public StepMeta getAcceptingStep() {
return acceptingStep;
}
/**
* @param acceptingStep The acceptingStep to set.
*/
public void setAcceptingStep( StepMeta acceptingStep ) {
this.acceptingStep = acceptingStep;
}
/**
* @return Returns the acceptingStepName.
*/
public String getAcceptingStepName() {
return acceptingStepName;
}
/**
* @param acceptingStepName The acceptingStepName to set.
*/
public void setAcceptingStepName( String acceptingStepName ) {
this.acceptingStepName = acceptingStepName;
}
@Override
public String[] getUsedLibraries() {
return new String[] { "jxl.jar", };
}
/**
* @return the encoding
*/
public String getEncoding() {
return encoding;
}
/**
* @param encoding the encoding to set
*/
public void setEncoding( String encoding ) {
this.encoding = encoding;
}
/**
* @param isaddresult The isaddresult to set.
*/
public void setAddResultFile( boolean isaddresult ) {
this.isaddresult = isaddresult;
}
/**
* @return Returns isaddresult.
*/
public boolean isAddResultFile() {
return isaddresult;
}
/**
* Read all sheets if the sheet names are left blank.
*
* @return true if all sheets are read.
*/
public boolean readAllSheets() {
return Utils.isEmpty( sheetName ) || ( sheetName.length == 1 && Utils.isEmpty( sheetName[ 0 ] ) );
}
/**
* @param space the variable space to use
* @param definitions
* @param resourceNamingInterface
* @param repository The repository to optionally load other resources from (to be converted to XML)
* @param metaStore the metaStore in which non-kettle metadata could reside.
* @return the filename of the exported resource
*/
@Override
public String exportResources( VariableSpace space, Map definitions,
ResourceNamingInterface resourceNamingInterface, Repository repository,
IMetaStore metaStore ) throws KettleException {
try {
normilizeAllocation();
// The object that we're modifying here is a copy of the original!
// So let's change the filename from relative to absolute by grabbing the file object...
// In case the name of the file comes from previous steps, forget about this!
//
if ( !acceptingFilenames ) {
// Replace the filename ONLY (folder or filename)
//
for ( int i = 0; i < fileName.length; i++ ) {
FileObject fileObject = KettleVFS.getFileObject( space.environmentSubstitute( fileName[ i ] ), space );
fileName[ i ] = resourceNamingInterface.nameResource( fileObject, space, Utils.isEmpty( fileMask[ i ] ) );
}
}
return null;
} catch ( Exception e ) {
throw new KettleException( e );
}
}
public SpreadSheetType getSpreadSheetType() {
return spreadSheetType;
}
public void setSpreadSheetType( SpreadSheetType spreadSheetType ) {
this.spreadSheetType = spreadSheetType;
}
/**
* If we use injection we can have different arrays lengths. We need synchronize them for consistency behavior with
* UI
*/
@AfterInjection
public void afterInjectionSynchronization() {
this.normilizeAllocation();
}
}