Package de.businesscode.bcdui.upload.data

Class UploadControl

java.lang.Object

de.businesscode.bcdui.upload.data.UploadControl

All Implemented Interfaces:

AutoCloseable

public class UploadControl
extends Object
implements AutoCloseable

Used for accessing bcd_dataupload_control table

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UploadControl.ReturnCode	Possible return codes for steps

Field Summary

Fields

Modifier and Type	Field	Description
static String	STEP_ID

Constructor Summary

Constructors

Constructor	Description
UploadControl(String uploadId)	For reading and updating entries in bcd_dataupload_control BLOB and uploadId are not updated
UploadControl(String userId, String sourceName, String targetBs, InputStream fileContent)	Constructor inserting an initial entry in bcd_dataupload_control

Method Summary

Modifier and Type	Method	Description
void	addStepResult(String stepId, UploadControl.ReturnCode rc)	insert a step result with no custom data
void	addStepResult(String stepId, UploadControl.ReturnCode rc, String jsonData)	insert a step result with extra JSON data
void	close()	Update all values (except BLOB and uploadId) into bcd_dataupload_control
String	getColumnStartings()
String	getDateFormat()
Character	getDecimalSeparator()
Character	getDelimiter()
String	getEncoding()
InputStream	getFileBlobIs()
int	getImportColumnCount()
int	getImportRowCount()
static Connection	getManagedUploadConnection(String stepId)	Returns a managed connection to the database where bcd_dataupload_control is located TODO allow to provide a BS name to find the right dbSourcename
String	getMappingBindingItemAttribute(int idx, String name)
int	getMappingBindingItemPos(String id)	retrieve the position of mapped binding item
Character	getQuoteChar()
String	getSheetName()
String	getSheetRange()
String	getSourceName()
String	getTargetBs()
String	getUploadId()
String	getUserComment()
String	getUserId()
Boolean	hasHeaderRow()
void	setColumnStartings(String columnStartings)
void	setDateFormat(String dateFormat)
void	setDecimalSeparator(Character decimalSeparator)
void	setDelimiter(Character delimiter)
void	setEncoding(String encoding)
void	setFileBlobIs(InputStream fileBlobIs)
void	setHasHeaderRow(Boolean hasHeaderRow)
void	setImportColumnCount(int columnCount)
void	setImportRowCount(int rowCount)
void	setMappingBindingItemAttribute(int idx, String name, String value)
void	setQuoteChar(Character quoteChar)
void	setSheetName(String sheetName)
void	setSheetRange(String sheetRange)
void	setSourceName(String sourceName)
void	setTargetBs(String targetBs)
void	setUploadId(String uploadId)
void	setUser_comment(String userComment)
void	setUserId(String userId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

STEP_ID

public static String STEP_ID

Constructor Details

UploadControl

public UploadControl(String userId,
 String sourceName,
 String targetBs,
 InputStream fileContent)
              throws UploadException

Constructor inserting an initial entry in bcd_dataupload_control

Parameters:

userId -

sourceName -

fileContent -

Throws:

Exception

UploadException

UploadControl

public UploadControl(String uploadId)
              throws UploadException

For reading and updating entries in bcd_dataupload_control BLOB and uploadId are not updated

Parameters:

uploadId -

Throws:

Exception

UploadException

Method Details

close

public void close()
           throws UploadException

Update all values (except BLOB and uploadId) into bcd_dataupload_control

Specified by:

close in interface AutoCloseable

Throws:

UploadException

getMappingBindingItemAttribute

public String getMappingBindingItemAttribute(int idx,
 String name)

setMappingBindingItemAttribute

public void setMappingBindingItemAttribute(int idx,
 String name,
 String value)

getMappingBindingItemPos

public int getMappingBindingItemPos(String id)

retrieve the position of mapped binding item

Parameters:

id -

Returns:

position (not index); 1-based of the mapping binding item

getManagedUploadConnection

public static Connection getManagedUploadConnection(String stepId)
                                             throws UploadException

Returns a managed connection to the database where bcd_dataupload_control is located TODO allow to provide a BS name to find the right dbSourcename

Returns:

Throws:

Exception

UploadException

addStepResult

public void addStepResult(String stepId,
 UploadControl.ReturnCode rc,
 String jsonData)
                   throws UploadException

insert a step result with extra JSON data

Parameters:

stepId -

rc -

jsonData - - a string in JSON notation

Throws:

UploadException

addStepResult

public void addStepResult(String stepId,
 UploadControl.ReturnCode rc)
                   throws UploadException

insert a step result with no custom data

Parameters:

stepId -

rc -

Throws:

UploadException

getUploadId

public String getUploadId()

setUploadId

public void setUploadId(String uploadId)

getSourceName

public String getSourceName()

setSourceName

public void setSourceName(String sourceName)

getUserId

public String getUserId()

setUserId

public void setUserId(String userId)

getUserComment

public String getUserComment()

setUser_comment

public void setUser_comment(String userComment)

getFileBlobIs

public InputStream getFileBlobIs()
                          throws Exception

Throws:

Exception

setFileBlobIs

public void setFileBlobIs(InputStream fileBlobIs)

getDelimiter

public Character getDelimiter()

setDelimiter

public void setDelimiter(Character delimiter)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getQuoteChar

public Character getQuoteChar()

setQuoteChar

public void setQuoteChar(Character quoteChar)

getDecimalSeparator

public Character getDecimalSeparator()

setDecimalSeparator

public void setDecimalSeparator(Character decimalSeparator)

hasHeaderRow

public Boolean hasHeaderRow()

setHasHeaderRow

public void setHasHeaderRow(Boolean hasHeaderRow)

getDateFormat

public String getDateFormat()

setDateFormat

public void setDateFormat(String dateFormat)

getColumnStartings

public String getColumnStartings()

setColumnStartings

public void setColumnStartings(String columnStartings)

getImportColumnCount

public int getImportColumnCount()

setImportColumnCount

public void setImportColumnCount(int columnCount)

getImportRowCount

public int getImportRowCount()

setImportRowCount

public void setImportRowCount(int rowCount)

getTargetBs

public String getTargetBs()

setTargetBs

public void setTargetBs(String targetBs)

getSheetName

public String getSheetName()

setSheetName

public void setSheetName(String sheetName)

getSheetRange

public String getSheetRange()

setSheetRange

public void setSheetRange(String sheetRange)