com.aspc.Layers.aspc_app.DBImport

Class DBImportTemplate

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.DBImport.DBImport

com.aspc.Layers.aspc_app.DBImport.DBImportTemplate

All Implemented Interfaces:

SecondaryCacheGroup

public class DBImportTemplate
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 DBImportTemplate
static java.lang.String	DBCLASS_NAME DBImportTemplate

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	findCategory(java.lang.String... args) Category.
java.lang.Object	getCategory(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
Importer	getImporter(Login login, ImportSource is)
java.lang.String	getInstructions(java.lang.String... args)
int	getLoadCacheMinRecords(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
DBImportTemplate	setCategory(java.lang.Object value, java.lang.String... args)
DBImportTemplate	setDescription(java.lang.String value, java.lang.String... args)
DBImportTemplate	setInstructions(java.lang.String value, java.lang.String... args)
DBImportTemplate	setLoadCacheMinRecords(int value, java.lang.String... args)
DBImportTemplate	setName(java.lang.String value, java.lang.String... args)

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

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

DBImportTemplate

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

DBImportTemplate

Constructor Detail

DBImportTemplate

public DBImportTemplate(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 DBImportTemplate setCategory(java.lang.Object value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

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

setDescription

@Nonnull
public DBImportTemplate setDescription(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getInstructions

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

setInstructions

@Nonnull
public DBImportTemplate setInstructions(java.lang.String value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getLoadCacheMinRecords

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

setLoadCacheMinRecords

@Nonnull
public DBImportTemplate setLoadCacheMinRecords(int value,
                                                        java.lang.String... args)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public DBImportTemplate setName(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getImporter

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

Parameters:

login -

is -

Returns:

the value

Throws:

java.lang.Exception - a serious problem