Package org.compiere.model

Class MImportTemplate

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_ImportTemplate

org.compiere.model.MImportTemplate

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_ImportTemplate, I_Persistent, Evaluatee, ImmutablePOSupport

public class MImportTemplate
extends X_AD_ImportTemplate
implements ImmutablePOSupport

Import Template Model

Author:

Carlos Ruiz - GlobalQSS

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	UTF16BE_BOM	Byte Order Mark character for UTF-16BE

Fields inherited from class org.compiere.model.X_AD_ImportTemplate

IMPORTTEMPLATETYPE_AD_Reference_ID, IMPORTTEMPLATETYPE_Comma_SeparatedValuesCSV, IMPORTTEMPLATETYPE_ExcelXLSXLSX, IMPORTTEMPLATETYPE_XLS

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_ImportTemplate

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_ImportTemplate_ID, COLUMNNAME_AD_ImportTemplate_UU, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Tab_ID, COLUMNNAME_AD_Window_ID, COLUMNNAME_CharacterSet, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_CSVAliasHeader, COLUMNNAME_CSVHeader, COLUMNNAME_Description, COLUMNNAME_ImportTemplateType, COLUMNNAME_IsActive, COLUMNNAME_Name, COLUMNNAME_QuoteChar, COLUMNNAME_SeparatorChar, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MImportTemplate(Properties ctx, int AD_ImportTemplate_ID, String trxName)	Standard Constructor
MImportTemplate(Properties ctx, String AD_ImportTemplate_UU, String trxName)	UUID based Constructor
MImportTemplate(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MImportTemplate(Properties ctx, MImportTemplate copy)	Copy constructor
MImportTemplate(Properties ctx, MImportTemplate copy, String trxName)	Copy constructor
MImportTemplate(MImportTemplate copy)	Copy constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	beforeSave(boolean newRecord)	Called before Save for Pre-Save Operation. Default implementation is nop, to be implemented in sub-classes that needed it.
InputStream	convertExcelToCSV(InputStream excelIs)	Convert an Excel (XLS or XLSX) file to CSV
static List<MImportTemplate>	getTemplates(int roleid, int tabid)	Get accessible import templates
boolean	isAllowed(String importMode, int roleID)
MImportTemplate	markImmutable()	mark PO as immutable
InputStream	validateFile(InputStream in)	- If needed preProcess the file when an Excel file and generate a CSV file, then - Validate that InputStream header is CSVHeader or AliasCSVHeader. - If the header is AliasCSVHeader it replaces it with the CSVHeader so it can be processed.

Methods inherited from class org.compiere.model.X_AD_ImportTemplate

get_AccessLevel, getAD_ImportTemplate_ID, getAD_ImportTemplate_UU, getAD_Tab, getAD_Tab_ID, getAD_Window, getAD_Window_ID, getCharacterSet, getCSVAliasHeader, getCSVHeader, getDescription, getImportTemplateType, getKeyNamePair, getName, getQuoteChar, getSeparatorChar, initPO, setAD_ImportTemplate_ID, setAD_ImportTemplate_UU, setAD_Tab_ID, setAD_Window_ID, setCharacterSet, setCSVAliasHeader, setCSVHeader, setDescription, setImportTemplateType, setName, setQuoteChar, setSeparatorChar, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_ImportTemplate

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Field Details

UTF16BE_BOM

public static final String UTF16BE_BOM

Byte Order Mark character for UTF-16BE

See Also:

• Constant Field Values

Constructor Details

MImportTemplate

public MImportTemplate(Properties ctx,
 String AD_ImportTemplate_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_ImportTemplate_UU - UUID key

trxName - Transaction

MImportTemplate

public MImportTemplate(Properties ctx,
 int AD_ImportTemplate_ID,
 String trxName)

Standard Constructor

Parameters:

ctx - context

AD_ImportTemplate_ID - id

trxName - transaction

MImportTemplate

public MImportTemplate(Properties ctx,
 ResultSet rs,
 String trxName)

Load Constructor

Parameters:

ctx - ctx

rs - result set

trxName - transaction

MImportTemplate

public MImportTemplate(MImportTemplate copy)

Copy constructor

Parameters:

copy -

MImportTemplate

public MImportTemplate(Properties ctx,
 MImportTemplate copy)

Copy constructor

Parameters:

ctx -

copy -

MImportTemplate

public MImportTemplate(Properties ctx,
 MImportTemplate copy,
 String trxName)

Copy constructor

Parameters:

ctx -

copy -

trxName -

Method Details

beforeSave

protected boolean beforeSave(boolean newRecord)

Description copied from class: PO

Called before Save for Pre-Save Operation.
Default implementation is nop, to be implemented in sub-classes that needed it.

Overrides:

beforeSave in class PO

Parameters:

newRecord - true if it is a new record

Returns:

true if record can be saved

getTemplates

public static List<MImportTemplate> getTemplates(int roleid,
 int tabid)

Get accessible import templates

Parameters:

roleid - AD_Role_ID

tabid - AD_Tab_ID

Returns:

list of MImportTemplate

isAllowed

public boolean isAllowed(String importMode,
 int roleID)

Parameters:

importMode - I (Insert), U (Update) or M (Merge)

roleID - AD_Role_ID

Returns:

true if role can perform importMode with this template

validateFile

public InputStream validateFile(InputStream in)

- If needed preProcess the file when an Excel file and generate a CSV file, then
- Validate that InputStream header is CSVHeader or AliasCSVHeader.
- If the header is AliasCSVHeader it replaces it with the CSVHeader so it can be processed.

Parameters:

in - input file

Returns:

InputStream with the CSVHeader that can be processed by CsvMapReader

convertExcelToCSV

public InputStream convertExcelToCSV(InputStream excelIs)
                              throws IOException

Convert an Excel (XLS or XLSX) file to CSV

Parameters:

excelIs - input stream containing XLS/XLSX

Returns:

input stream containing CSV

Throws:

IOException

markImmutable

public MImportTemplate markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO