com.ibm.etools.iseries.subsystems.qsys.objects
Class QSYSRemoteDatabaseFile

java.lang.Object
  com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly
      com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief
          com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic
              com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive
                  com.ibm.etools.iseries.services.qsys.objects.QSYSHostObject
                      com.ibm.etools.iseries.subsystems.qsys.objects.QSYSRemoteObject
                          com.ibm.etools.iseries.subsystems.qsys.objects.QSYSRemoteFile
                              com.ibm.etools.iseries.subsystems.qsys.objects.QSYSRemoteDatabaseFile

All Implemented Interfaces:

IISeriesHostFileDefinition, IISeriesHostObjectBasic, IISeriesHostObjectBrief, IISeriesHostObjectExhaustive, IISeriesHostObjectNameOnly, IQSYSDatabaseFile, IQSYSFile, IQSYSObject, IQSYSResource, IRemoteObjectContextProvider

Direct Known Subclasses:

QSYSRemoteDDMFile, QSYSRemoteLogicalFile, QSYSRemotePhysicalFile

public abstract class QSYSRemoteDatabaseFile
extends QSYSRemoteFile
implements IQSYSDatabaseFile

Class representing an IBM i database file (parent to logical, physical and source files)

Field Summary

static String

copyright

Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive

activeDate, allowChgByPgm, apar, auditingValue, auxPool, changedByPgm, compiler, compressionStatus, Copyright, daysUsed, domain, lastUsedDate, level, licPgm, overflowedASP, owner, primaryGroup, profile, ptf, resetDate, restoredDate, saveCmd, saveDate, saveDevice, saveFile, saveLabel, saveLib, saveSeqNbr, saveSize, saveVolumeId, srcDate, srcFile, srcLib, srcMbr, storage, systemCreated, systemLevel, usageInfoUpdated, userChanged, userDefinedAttribute

Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic

changeDate, createDate, size

Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief

file, subtype, type

Fields inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly

library, name

Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

AUDITING_ALL, AUDITING_CHANGE, AUDITING_NONE, AUDITING_USRPRF, COMPRESSION_COMPRESSED, COMPRESSION_NOTCOMPRESSABLE, COMPRESSION_NOTCOMPRESSED, COMPRESSION_SAVEDFREED, COMPRESSION_TEMPORARILYCOMPRESSED, Copyright, DOMAIN_SYSTEM, DOMAIN_USER, STORAGE_FREE, STORAGE_KEEP

Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief

STATUS_DAMAGED, STATUS_LOCKED, STATUS_NOTAUTHORIZED, STATUS_OK, STATUS_PARTIALLYDAMAGED, STATUS_STRING_DAMAGED, STATUS_STRING_LOCKED, STATUS_STRING_NOTAUTHORIZED, STATUS_STRING_PARTIALLYDAMAGED

Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostFileDefinition

ARRIVAL_SEQ, Copyright, ENCODED_VECTOR_SEQ, KEYED_FCFO_SEQ, KEYED_FIFO_SEQ, KEYED_LIFO_SEQ, KEYED_NO_ORDER_SEQ, KEYED_UNIQUE_SEQ

Constructor Summary

QSYSRemoteDatabaseFile()

Method Summary

void	addBasedOnFile(String library, String file, String record) Add a based on file to the list of based on files for this logical file.
String	getAccessPathType() Get the access path type.
boolean	getAlternateSequence() Check whether this record format uses an alternate collating sequence (ALTSEQ)
int	getBasedOnCount() Get the number of files this file is based on.
List<String>	getBasedOnFiles() Return a list of the based on files
boolean	getDynamicSelect() Check whether this record format uses the dynamic selection indicator (DYNSLT).
boolean	getIGCField() Check whether this record format contains DBCS or Graphic data.
boolean	getIGCLiteral() Check whether this record format contains DBCS or Graphic literals.
boolean	getKeyedAccessPath() Check whether this record format has a keyed sequence access path.
String	getLangId() Get the language identifier
IQSYSDatabaseFileRecordFormat	getRecordFormat(IProgressMonitor monitor) Return the first record format in the physical file
IQSYSDatabaseFileRecordFormat	getRecordFormat(String record, IProgressMonitor monitor) Get the specified record.
boolean	getSelectOmitLF() Check whether this file is a select/omit logical file.
boolean	hasFileProperties()
boolean	isJoinLogicalFile() Check whether this record format is a join logical file
boolean	isSourceFile() Check whether this record format is source file.
void	setAccessPathType(String accessPathType) Set the access path type for this record format.
void	setAlternateSequence(boolean altSeq) Set whether this record format uses an alternate collating sequence (ALTSEQ)
void	setBasedOnCount(int count) Set the number of files this file is based on.
void	setBasedOnFiles(List<String> files) Set the based on files
void	setDynamicSelect(boolean dynamicSelect) Set whether this record format uses the dynamic selection indicator (DYNSLT).
void	setIGCField(boolean igcField) Set whether this record format contains DBCS or Graphic data.
void	setIGCLiteral(boolean igcLiteral) Set whether this record format contains DBCS or Graphic literals.
void	setIsSourceFile(boolean sourceFile) Set whether this record format is source file or a data file.
void	setJoinLogicalFile(boolean jfile) Set whether this record format is a join logical file
void	setKeyedAccessPath(boolean keyed) Set whether this record format has a keyed sequence access path.
void	setLangId(String langId) Set the language identifier
void	setSelectOmitLF(boolean selectOmitLF) Set whether this file is a select/omit logical file.

Methods inherited from class com.ibm.etools.iseries.subsystems.qsys.objects.QSYSRemoteFile

listRecordFormats

Methods inherited from class com.ibm.etools.iseries.subsystems.qsys.objects.QSYSRemoteObject

clearCachedProperties, equals, exists, getAbsoluteName, getAdapter, getAllowChangeByProgram, getAPAR, getAuxiliaryStoragePool, getChangedByProgram, getCompiler, getCompressionStatus, getCreatorUserProfile, getDateCreated, getDateModified, getDaysUsedCount, getDomain, getExhaustiveProperties, getLastUsedDate, getLicensedProgram, getObjectAuditingValue, getObjectLevel, getObjectOverflowedASP, getOwner, getParent, getPrimaryGroup, getPTF, getRemoteObjectContext, getResetDate, getRestoredDate, getSaveActiveDate, getSaveCommand, getSavedDate, getSaveDevice, getSaveFileName, getSaveLabel, getSaveLibrary, getSaveSequenceNumber, getSaveSize, getSaveVolumeId, getSize, getSourceChangedDate, getSourceFile, getSourceLibrary, getSourceMember, getStorage, getSystemLevel, getSystemWhereCreated, getUsageInformationUpdated, getUserChanged, getUserDefinedAttribute, hasAdditionalDetails, hashCode, setDateCreated, setRemoteObjectContext

Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectExhaustive

setAllowChangeByProgram, setAPAR, setAuxiliaryStoragePool, setChangedByProgram, setCompiler, setCompressionStatus, setCreatorUserProfile, setDaysUsedCount, setDomain, setLastUsedDate, setLicensedProgram, setObjectAuditingValue, setObjectLevel, setObjectOverflowedASP, setOwner, setPrimaryGroup, setPTF, setResetDate, setRestoredDate, setSaveActiveDate, setSaveCommand, setSavedDate, setSaveDevice, setSaveFileName, setSaveLabel, setSaveLibrary, setSaveSequenceNumber, setSaveSize, setSaveVolumeId, setSourceChangedDate, setSourceFile, setSourceLibrary, setSourceMember, setStorage, setSystemLevel, setSystemWhereCreated, setUsageInformationUpdated, setUserChanged, setUserDefinedAttribute, writeObjectInfo

Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBasic

getFullName, setDateModified, setSize

Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectBrief

getDescription, getFile, getInformationStatus, getSubType, getType, setDescription, setFile, setInformationStatus, setSubType, setType, toString

Methods inherited from class com.ibm.etools.iseries.comm.interfaces.ISeriesHostObjectNameOnly

getLibrary, getName, setLibrary, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.etools.iseries.services.qsys.api.IQSYSFile

listRecordFormats

Methods inherited from interface com.ibm.etools.iseries.services.qsys.api.IQSYSObject

clearCachedProperties

Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive

getAllowChangeByProgram, getAPAR, getAuxiliaryStoragePool, getChangedByProgram, getCompiler, getCompressionStatus, getCreatorUserProfile, getDaysUsedCount, getDomain, getLastUsedDate, getLicensedProgram, getObjectAuditingValue, getObjectLevel, getObjectOverflowedASP, getOwner, getPrimaryGroup, getPTF, getResetDate, getRestoredDate, getSaveActiveDate, getSaveCommand, getSavedDate, getSaveDevice, getSaveFileName, getSaveLabel, getSaveLibrary, getSaveSequenceNumber, getSaveSize, getSaveVolumeId, getSourceChangedDate, getSourceFile, getSourceLibrary, getSourceMember, getStorage, getSystemLevel, getSystemWhereCreated, getUsageInformationUpdated, getUserChanged, getUserDefinedAttribute, setAllowChangeByProgram, setAPAR, setAuxiliaryStoragePool, setChangedByProgram, setCompiler, setCompressionStatus, setCreatorUserProfile, setDaysUsedCount, setDomain, setLastUsedDate, setLicensedProgram, setObjectAuditingValue, setObjectLevel, setObjectOverflowedASP, setOwner, setPrimaryGroup, setPTF, setResetDate, setRestoredDate, setSaveActiveDate, setSaveCommand, setSavedDate, setSaveDevice, setSaveFileName, setSaveLabel, setSaveLibrary, setSaveSequenceNumber, setSaveSize, setSaveVolumeId, setSourceChangedDate, setSourceFile, setSourceLibrary, setSourceMember, setStorage, setSystemLevel, setSystemWhereCreated, setUsageInformationUpdated, setUserChanged, setUserDefinedAttribute

Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic

getDateCreated, getDateModified, getSize, setDateCreated, setDateModified, setSize

Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief

getDescription, getFile, getInformationStatus, getSubType, getType, setDescription, setFile, setInformationStatus, setSubType, setType

Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly

getLibrary, getName, setLibrary, setName, toString, writeObjectInfo

Methods inherited from interface com.ibm.etools.iseries.services.qsys.api.IQSYSResource

exists, getAbsoluteName, getDateCreated, getDateModified, getDescription, getFullName, getLibrary, getName, getParent, getSize, getSubType, getType, setDescription, setLibrary, setName, setSubType, setType

Field Detail

copyright

public static String copyright

Constructor Detail

QSYSRemoteDatabaseFile

public QSYSRemoteDatabaseFile()

Method Detail

getRecordFormat

public IQSYSDatabaseFileRecordFormat getRecordFormat(IProgressMonitor monitor)
                                              throws SystemMessageException,
                                                     InterruptedException

Description copied from interface: IQSYSDatabaseFile

Return the first record format in the physical file

Specified by:

getRecordFormat in interface IQSYSDatabaseFile

Throws:

SystemMessageException

InterruptedException

getRecordFormat

public IQSYSDatabaseFileRecordFormat getRecordFormat(String record,
                                                     IProgressMonitor monitor)
                                              throws SystemMessageException,
                                                     InterruptedException

Description copied from interface: IQSYSFile

Get the specified record.

Specified by:

getRecordFormat in interface IQSYSDatabaseFile

Specified by:

getRecordFormat in interface IQSYSFile

Overrides:

getRecordFormat in class QSYSRemoteFile

Throws:

SystemMessageException

InterruptedException

getAccessPathType

public String getAccessPathType()
                         throws SystemMessageException,
                                InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Get the access path type.

Specified by:

getAccessPathType in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getAccessPathType()

getLangId

public String getLangId()
                 throws SystemMessageException,
                        InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Get the language identifier

Specified by:

getLangId in interface IISeriesHostFileDefinition

Throws:

SystemMessageException

InterruptedException

getAlternateSequence

public boolean getAlternateSequence()
                             throws SystemMessageException,
                                    InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Check whether this record format uses an alternate collating sequence (ALTSEQ)

Specified by:

getAlternateSequence in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getAlternateSequence()

getBasedOnCount

public int getBasedOnCount()
                    throws SystemMessageException,
                           InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Get the number of files this file is based on.

Specified by:

getBasedOnCount in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getBasedOnCount()

getDynamicSelect

public boolean getDynamicSelect()
                         throws SystemMessageException,
                                InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Check whether this record format uses the dynamic selection indicator (DYNSLT). If on, the selection and omission tests specified for the file are done when the file is read. If off, when the access path is updated.

Specified by:

getDynamicSelect in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getDynamicSelect()

getIGCLiteral

public boolean getIGCLiteral()
                      throws SystemMessageException,
                             InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Check whether this record format contains DBCS or Graphic literals.

Specified by:

getIGCLiteral in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getIGCLiteral()

getKeyedAccessPath

public boolean getKeyedAccessPath()
                           throws SystemMessageException,
                                  InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Check whether this record format has a keyed sequence access path.

Specified by:

getKeyedAccessPath in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getKeyedAccessPath()

getSelectOmitLF

public boolean getSelectOmitLF()
                        throws SystemMessageException,
                               InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Check whether this file is a select/omit logical file.

Specified by:

getSelectOmitLF in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getSelectOmitLF()

isJoinLogicalFile

public boolean isJoinLogicalFile()
                          throws SystemMessageException,
                                 InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Check whether this record format is a join logical file

Specified by:

isJoinLogicalFile in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.isJoinLogicalFile()

getIGCField

public boolean getIGCField()
                    throws SystemMessageException,
                           InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Check whether this record format contains DBCS or Graphic data.

Specified by:

getIGCField in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getIGCField()

isSourceFile

public boolean isSourceFile()
                     throws SystemMessageException,
                            InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Check whether this record format is source file. If the file is not a source file then it must be a data file.

Specified by:

isSourceFile in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.isSourceFile()

getBasedOnFiles

public List<String> getBasedOnFiles()
                             throws SystemMessageException,
                                    InterruptedException

Description copied from interface: IISeriesHostFileDefinition

Return a list of the based on files

Specified by:

getBasedOnFiles in interface IISeriesHostFileDefinition

Throws:

InterruptedException

SystemMessageException

See Also:

IISeriesHostFileDefinition.getBasedOnFiles()

setAccessPathType

public void setAccessPathType(String accessPathType)

Description copied from interface: IISeriesHostFileDefinition

Set the access path type for this record format.

Specified by:

setAccessPathType in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setAccessPathType(String)

setAlternateSequence

public void setAlternateSequence(boolean altSeq)

Description copied from interface: IISeriesHostFileDefinition

Set whether this record format uses an alternate collating sequence (ALTSEQ)

Specified by:

setAlternateSequence in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setAlternateSequence(boolean)

setBasedOnCount

public void setBasedOnCount(int count)

Description copied from interface: IISeriesHostFileDefinition

Set the number of files this file is based on.

Specified by:

setBasedOnCount in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setBasedOnCount(int)

setDynamicSelect

public void setDynamicSelect(boolean dynamicSelect)

Description copied from interface: IISeriesHostFileDefinition

Set whether this record format uses the dynamic selection indicator (DYNSLT).

Specified by:

setDynamicSelect in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setDynamicSelect(boolean)

setIGCLiteral

public void setIGCLiteral(boolean igcLiteral)

Description copied from interface: IISeriesHostFileDefinition

Set whether this record format contains DBCS or Graphic literals.

Specified by:

setIGCLiteral in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setIGCLiteral(boolean)

setKeyedAccessPath

public void setKeyedAccessPath(boolean keyed)

Description copied from interface: IISeriesHostFileDefinition

Set whether this record format has a keyed sequence access path.

Specified by:

setKeyedAccessPath in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setKeyedAccessPath(boolean)

setSelectOmitLF

public void setSelectOmitLF(boolean selectOmitLF)

Description copied from interface: IISeriesHostFileDefinition

Set whether this file is a select/omit logical file.

Specified by:

setSelectOmitLF in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setSelectOmitLF(boolean)

setJoinLogicalFile

public void setJoinLogicalFile(boolean jfile)

Description copied from interface: IISeriesHostFileDefinition

Set whether this record format is a join logical file

Specified by:

setJoinLogicalFile in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setJoinLogicalFile(boolean)

setIGCField

public void setIGCField(boolean igcField)

Description copied from interface: IISeriesHostFileDefinition

Set whether this record format contains DBCS or Graphic data.

Specified by:

setIGCField in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setIGCField(boolean)

setIsSourceFile

public void setIsSourceFile(boolean sourceFile)

Description copied from interface: IISeriesHostFileDefinition

Set whether this record format is source file or a data file.

Specified by:

setIsSourceFile in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.setIsSourceFile(boolean)

addBasedOnFile

public void addBasedOnFile(String library,
                           String file,
                           String record)

Description copied from interface: IISeriesHostFileDefinition

Add a based on file to the list of based on files for this logical file.

Specified by:

addBasedOnFile in interface IISeriesHostFileDefinition

See Also:

IISeriesHostFileDefinition.addBasedOnFile(String, String, String)

setLangId

public void setLangId(String langId)

Description copied from interface: IISeriesHostFileDefinition

Set the language identifier

Specified by:

setLangId in interface IISeriesHostFileDefinition

setBasedOnFiles

public void setBasedOnFiles(List<String> files)

Description copied from interface: IQSYSDatabaseFile

Set the based on files

Specified by:

setBasedOnFiles in interface IQSYSDatabaseFile

hasFileProperties

public boolean hasFileProperties()