com.aspc.Layers.aspc_app.DBImport

Class DBImport

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.DBImport.DBImport

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

DBImportFile, DBImportTemplate

public class DBImport
extends DBObject

Stores details of a file to be imported into the database system along with how the data in that file will be stored within the database.
Stores details about the import of data into the system.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

7 February 2003, 09:13

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Stores details about the import of data into the system.
static java.lang.String	DBCLASS_NAME Stores details about the import of data into the system.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBImport(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected ImportFieldDef	buildFieldDef(DBImportField fld, DBClass baseClass)
protected void	extFixUp() The extended fix up routine for known problems.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
DBClassAbstract	findBaseClass(java.lang.String... args) Base Class.
Person	findEnteredBy(java.lang.String... args) Entered By.
DBFieldDelimiter	findFieldDelimiter(java.lang.String... args) Character that seperates fields in the file to be imported.
static DBImport	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBClassAbstract	getBaseClass(java.lang.String... args)
java.util.Date	getCreatedDateTime(java.lang.String... args)
java.lang.String	getDatasourcePlugin(java.lang.String... args)
java.lang.Class	getDataSourcePluginClass()
java.lang.String	getDateFormat(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
DBFieldDelimiter	getFieldDelimiter(java.lang.String... args)
int	getID(java.lang.String... args)
Importer	getImporter(DBClass baseClass, Login login, ImportSource is)
java.lang.Object	getPlugin()
int	getStartAtLine(java.lang.String... args)
java.lang.String	getTimeFormat(java.lang.String... args)
boolean	isOverwrite(java.lang.String... args)
static DBQuery<DBImport>	makeQuery(DataSource ds) Make a new QUERY for this class.
DBImport	setBaseClass(com.aspc.dal.dbobj.DBClassAbstract value, java.lang.String... args)
DBImport	setCreatedDateTime(java.util.Date value, java.lang.String... args)
DBImport	setDatasourcePlugin(java.lang.String value, java.lang.String... args)
DBImport	setDateFormat(java.lang.String value, java.lang.String... args)
DBImport	setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
DBImport	setFieldDelimiter(com.aspc.dal.dbobj.misc.DBFieldDelimiter value, java.lang.String... args)
DBImport	setID(int value, java.lang.String... args)
DBImport	setOverwrite(boolean value, java.lang.String... args)
DBImport	setPlugin(java.lang.String value, java.lang.String... args)
DBImport	setStartAtLine(int value, java.lang.String... args)
DBImport	setTimeFormat(java.lang.String value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Stores details about the import of data into the system.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Stores details about the import of data into the system.

Constructor Detail

DBImport

public DBImport(DBClass def,
                DataSource dataSource)
         throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public DBImport setID(int value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getBaseClass

@CheckReturnValue
 @Nullable
public DBClassAbstract getBaseClass(java.lang.String... args)

findBaseClass

@CheckReturnValue
 @Nonnull
public final DBClassAbstract findBaseClass(java.lang.String... args)
                                                                throws NotFoundException

Base Class.

--> DBClassAbstract (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

setBaseClass

@Nonnull
public DBImport setBaseClass(com.aspc.dal.dbobj.DBClassAbstract value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getCreatedDateTime

@CheckReturnValue
 @Nullable
public java.util.Date getCreatedDateTime(java.lang.String... args)

setCreatedDateTime

@Nonnull
public DBImport setCreatedDateTime(java.util.Date value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getDatasourcePlugin

@CheckReturnValue
 @Nonnull
public java.lang.String getDatasourcePlugin(java.lang.String... args)

setDatasourcePlugin

@Nonnull
public DBImport setDatasourcePlugin(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDateFormat

@CheckReturnValue
 @Nonnull
public java.lang.String getDateFormat(java.lang.String... args)

setDateFormat

@Nonnull
public DBImport setDateFormat(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getEnteredBy

@CheckReturnValue
 @Nullable
public Person getEnteredBy(java.lang.String... args)

findEnteredBy

@CheckReturnValue
 @Nonnull
public final Person findEnteredBy(java.lang.String... args)
                                                       throws NotFoundException

Entered By.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnteredBy

@Nonnull
public DBImport setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getFieldDelimiter

@CheckReturnValue
 @Nullable
public DBFieldDelimiter getFieldDelimiter(java.lang.String... args)

findFieldDelimiter

@CheckReturnValue
 @Nonnull
public final DBFieldDelimiter findFieldDelimiter(java.lang.String... args)
                                                                      throws NotFoundException

Character that seperates fields in the file to be imported.

--> DBFieldDelimiter (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DBFieldDelimiter

Throws:

NotFoundException - DBFieldDelimiter was not found

setFieldDelimiter

@Nonnull
public DBImport setFieldDelimiter(com.aspc.dal.dbobj.misc.DBFieldDelimiter value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

isOverwrite

@CheckReturnValue
public boolean isOverwrite(java.lang.String... args)

setOverwrite

@Nonnull
public DBImport setOverwrite(boolean value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

setPlugin

@Nonnull
public DBImport setPlugin(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getStartAtLine

@CheckReturnValue
public int getStartAtLine(java.lang.String... args)

setStartAtLine

@Nonnull
public DBImport setStartAtLine(int value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getTimeFormat

@CheckReturnValue
 @Nonnull
public java.lang.String getTimeFormat(java.lang.String... args)

setTimeFormat

@Nonnull
public DBImport setTimeFormat(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DBImport> makeQuery(@Nonnull
                                                                      DataSource ds)
                                                               throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static DBImport findKey(@Nonnull
                                                           DataSource ds,
                                                           int key)
                                                    throws NotFoundException,
                                                           java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

getImporter

public Importer getImporter(DBClass baseClass,
                            Login login,
                            ImportSource is)
                     throws java.lang.Exception

Parameters:

baseClass - The base class

login -

is -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - A serious problem

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

buildFieldDef

protected ImportFieldDef buildFieldDef(DBImportField fld,
                                       DBClass baseClass)
                                throws java.lang.Exception

Parameters:

fld -

baseClass - The base class

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

getPlugin

public java.lang.Object getPlugin()
                           throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getDataSourcePluginClass

public java.lang.Class getDataSourcePluginClass()
                                         throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem