com.aspc.Layers.aspc_app.DBImport

Class DBImportFile

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.DBImport.DBImport

com.aspc.Layers.aspc_app.DBImport.DBImportFile

All Implemented Interfaces:

SecondaryCacheGroup

public class DBImportFile
extends DBImport

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. Generic DBObject.

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 DBImportFile
static java.lang.String	DBCLASS_NAME DBImportFile

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extFixUp() The extended fix up routine for known problems.
java.lang.Object	findCategory(java.lang.String... args) Category.
DBFile	findImportFile(java.lang.String... args) File to import.
DBImportTemplate	findTemplate(java.lang.String... args) Setting a template will cause all settings to be prefilled with the settings from that template.
java.lang.Object	getCategory(java.lang.String... args)
Importer	getImporter()
DBFile	getImportFile(java.lang.String... args)
DBImportTemplate	getTemplate(java.lang.String... args)
DBImportFile	setCategory(java.lang.Object value, java.lang.String... args)
DBImportFile	setImportFile(com.aspc.dal.file.DBFile value, java.lang.String... args)
DBImportFile	setTemplate(com.aspc.dal.layers.aspc_app.dbimport.DBImportTemplate value, java.lang.String... args)

Methods inherited from class com.aspc.Layers.aspc_app.DBImport.DBImport

buildFieldDef, extValidateField, extValidateRecord, findBaseClass, findEnteredBy, findFieldDelimiter, findKey, getBaseClass, getCreatedDateTime, getDatasourcePlugin, getDataSourcePluginClass, getDateFormat, getEnteredBy, getFieldDelimiter, getID, getImporter, getPlugin, getStartAtLine, getTimeFormat, isOverwrite, makeQuery, setBaseClass, setCreatedDateTime, setDatasourcePlugin, setDateFormat, setEnteredBy, setFieldDelimiter, setID, setOverwrite, setPlugin, setStartAtLine, setTimeFormat

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, 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

DBImportFile

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

DBImportFile

Constructor Detail

DBImportFile

public DBImportFile(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

getCategory

@CheckReturnValue
 @Nullable
public java.lang.Object getCategory(java.lang.String... args)

findCategory

@CheckReturnValue
 @Nonnull
public final java.lang.Object findCategory(java.lang.String... args)
                                                                throws NotFoundException

Category.

--> ImportTemplateCategory (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ImportTemplateCategory

Throws:

NotFoundException - ImportTemplateCategory was not found

setCategory

@Nonnull
public DBImportFile setCategory(java.lang.Object value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getImportFile

@CheckReturnValue
 @Nullable
public DBFile getImportFile(java.lang.String... args)

findImportFile

@CheckReturnValue
 @Nonnull
public final DBFile findImportFile(java.lang.String... args)
                                                        throws NotFoundException

File to import.

--> DBFile (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setImportFile

@Nonnull
public DBImportFile setImportFile(com.aspc.dal.file.DBFile value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getTemplate

@CheckReturnValue
 @Nullable
public DBImportTemplate getTemplate(java.lang.String... args)

findTemplate

@CheckReturnValue
 @Nonnull
public final DBImportTemplate findTemplate(java.lang.String... args)
                                                                throws NotFoundException

Setting a template will cause all settings to be prefilled with the settings from that template.

--> DBImportTemplate (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

DBImportTemplate

Throws:

NotFoundException - DBImportTemplate was not found

setTemplate

@Nonnull
public DBImportFile setTemplate(com.aspc.dal.layers.aspc_app.dbimport.DBImportTemplate value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getImporter

public Importer getImporter()
                     throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

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 DBImport

Throws:

java.lang.Exception - A serious problem