|
iSeries Remote Systems v6.0.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
com.ibm.etools.iseries.core.api.ISeriesHostObjectBriefWrapper
com.ibm.etools.iseries.core.api.ISeriesHostObjectBasicWrapper
com.ibm.etools.iseries.core.api.ISeriesHostObjectExhaustiveWrapper
com.ibm.etools.iseries.core.api.ISeriesObject
com.ibm.etools.iseries.core.api.ISeriesFile
This is a usable representation of a src/data/logical file object on a remote iSeries object. It contains most of the attributes as retrieved from the system api for listing objects. It is a specialization of ISeriesObject
This object is instantiated from the DataElement object that is normally returned from a remote list request.
Note that the setXXX methods do not change the file on the host. Rather, their purpose is simply to capture the attribute internally, after reading it from an external source, say.
See the iSeries CL API QUSLOBJ for a full description of each attribute
Field Summary | |
---|---|
protected String |
_accessPathType
|
protected boolean |
_alternateSequence
|
protected int |
_basedOnCount
|
protected String |
_basedOnFiles
|
protected boolean |
_dynamicSelect
|
protected boolean |
_igcField
|
protected boolean |
_igcLiteral
|
protected boolean |
_jfile
|
protected boolean |
_keyedAccessPath
|
protected boolean |
_selectOmit
|
static String |
copyright
|
protected int |
iCcsid
|
protected int |
iRecordLength
|
protected boolean |
isDBCS
|
protected boolean |
isSrcFile
|
Fields inherited from class com.ibm.etools.iseries.core.api.ISeriesObject |
---|
bBasicPropertiesAvailable, bExhaustivePropertiesAvailable, bValue, calendar, cValue, date, day, deProperties, deProperty, hour, iValue, lValue, minute, month, sbValue, second, sValue, year |
Fields inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper |
---|
cacheFilter, cacheTimeStamp, dataelement, EXPIRE_TIME, lastException, lastRunMsg, lastRunMsgId, localCache |
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 |
Constructor Summary | |
---|---|
ISeriesFile(com.ibm.etools.systems.dstore.core.model.DataElement dataelement,
boolean sourceFile)
Constructor |
Method Summary | |
---|---|
ISeriesMember |
createSourceMember(Shell shell,
String mbrName,
String mbrType,
String mbrText)
Create a source member in this file, given a member name and source type, and optionally descriptive text |
boolean |
exists()
Queries whether the file exists |
String |
getAccessPathType()
Returns the accessPathType for this file. |
int |
getBasedOnCount()
Returns the number of files this file is based on. |
String |
getBasedOnFiles()
Returns the files this file is based on. |
int |
getCcsid()
Return the ccsid value for this file |
String |
getEncoding()
Get the encoding of the file represented by its CCSID |
String |
getFileSubType()
|
String |
getLangId()
|
ISeriesRecord |
getRecord(Shell shell)
Retrieve the record format for this file. |
ISeriesRecord |
getRecord(Shell shell,
String recordName)
Return the record format this file. |
com.ibm.etools.iseries.comm.interfaces.IISeriesRecord |
getRecord(String recordName)
Return the record format from this file. |
int |
getRecordLength()
Return the record length of this file |
boolean |
isAlternateSequence()
Returns whether this file has an alternate sequence table specified. |
boolean |
isDBCS()
Returns whether the file is a DBCS file or not |
boolean |
isDynamicSelect()
Check if the selection and omission tests specified for the file are done when the file is read or when the access path is updated. |
boolean |
isIgcField()
Check if the file's record format(s) contain DBCS or graphic fields. |
boolean |
isIgcLiteral()
Check if the file's record format(s) contain DBCS or graphic literals. |
boolean |
isJoinLogicalFile()
Check if this is a join logical file. |
boolean |
isKeyedAccessPath()
Check if the file has a keyed sequence access path or an arrival sequence access path. |
boolean |
isSelectOmit()
Returns the selectOmit. |
boolean |
isSourceFile()
Return true if this is a source file |
ISeriesDatabaseField[] |
listFields(Shell shell)
Deprecated. Use listRecords() first and then use the listFields() method on the record. |
ISeriesDatabaseField[] |
listFields(Shell shell,
String recordName,
String fieldName)
Deprecated. Use listRecords() first and then use the listFields() method on the record. |
static String[] |
listMemberNames(Shell shell,
ISeriesConnection connection,
String library,
String file,
String nameFilter,
String[] typeFilters)
This is a high performance way to query the members names only in a given file, optionally subset by member name and type. |
String[] |
listMemberNames(Shell shell,
String nameFilter,
String[] typeFilters)
This is a high performance way to query the members names only in this file, optionally subset by member name and type. |
ISeriesMember[] |
listMembers(Shell shell)
Return a list of all members |
ISeriesMember[] |
listMembers(Shell shell,
String nameFilter)
Return a list of members subsetted by the member name |
ISeriesMember[] |
listMembers(Shell shell,
String[] mbrTypes)
Return a list of members, subset by member type(s) |
ISeriesMember[] |
listMembers(Shell shell,
String nameFilter,
String[] mbrTypes)
Return a list of members subsetted by member name and type |
static String[] |
listRecordNames(Shell shell,
ISeriesConnection connection,
String library,
String file,
String nameFilter)
This is a high performance way to query the record names only in a given file, optionally subset by record name. |
String[] |
listRecordNames(Shell shell,
String nameFilter)
This is a high performance way to query the record names only in this file. |
com.ibm.etools.iseries.comm.interfaces.IISeriesRecord[] |
listRecords()
Return a list of all records for this file |
ISeriesRecord[] |
listRecords(Shell shell)
Return a list of all records for this file |
ISeriesRecord[] |
listRecords(Shell shell,
String filterName)
Return a list of records for this file object that match the filterName |
void |
showFieldsInTable(Shell shell)
Instance method to easily show the fields table for this file. |
static void |
showFieldsInTable(Shell shell,
ISeriesConnection conn400,
String libName,
String fileName)
Static method to easily show the fields table, given the minimum information needed. |
void |
showMembersInTable(Shell shell)
Instance method to easily show the members table for this file. |
static void |
showMembersInTable(Shell shell,
ISeriesConnection conn400,
String libName,
String fileName)
Static method to easily show the members table, given the minimum information needed. |
Methods inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper |
---|
checkIsConnected, extractProperty, extractPropertyAsBoolean, extractPropertyAsByte, extractPropertyAsChar, extractPropertyAsInt, getCommandSubSystem, getDataElement, getDataStore, getFileSubSystem, getISeriesConnection, getLastException, getLastRunMessage, getLocalCache, getPropertiesNode, runCommand, setLastException, setLocalCache |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile |
---|
getLibraryName |
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 |
Field Detail |
public static final String copyright
protected boolean isSrcFile
protected boolean isDBCS
protected int iCcsid
protected int iRecordLength
protected boolean _igcField
protected boolean _igcLiteral
protected boolean _alternateSequence
protected boolean _keyedAccessPath
protected boolean _jfile
protected boolean _selectOmit
protected boolean _dynamicSelect
protected String _accessPathType
protected int _basedOnCount
protected String _basedOnFiles
Constructor Detail |
public ISeriesFile(com.ibm.etools.systems.dstore.core.model.DataElement dataelement, boolean sourceFile)
Method Detail |
public boolean isSourceFile()
isSourceFile
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile
public ISeriesMember[] listMembers(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
shell
- A shell that can be used to create the Signon prompt dialog if required, if null
is passed then the workbench will be searched for a shell to use for the Signon
prompt
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesMember[] listMembers(Shell shell, String[] mbrTypes) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesMember[] listMembers(Shell shell, String nameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesMember[] listMembers(Shell shell, String nameFilter, String[] mbrTypes) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.etools.iseries.comm.interfaces.IISeriesRecord[] listRecords() throws Exception
listRecords
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile
Exception
public ISeriesRecord[] listRecords(Shell shell, String filterName) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesRecord[] listRecords(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String[] listRecordNames(Shell shell, String nameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
shell
- The hosting dialognameFilter
- A generic name pattern for the records. Can be null for all record names.
com.ibm.etools.systems.core.messages.SystemMessageException
public static String[] listRecordNames(Shell shell, ISeriesConnection connection, String library, String file, String nameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String[] listMemberNames(Shell shell, String nameFilter, String[] typeFilters) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public static String[] listMemberNames(Shell shell, ISeriesConnection connection, String library, String file, String nameFilter, String[] typeFilters) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesRecord getRecord(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesRecord getRecord(Shell shell, String recordName) throws com.ibm.etools.systems.core.messages.SystemMessageException
recordName
- The name of the record to retrieve.
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.etools.iseries.comm.interfaces.IISeriesRecord getRecord(String recordName) throws Exception
getRecord
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile
recordName
- The name of the record to retrieve.
Exception
public ISeriesDatabaseField[] listFields(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesDatabaseField[] listFields(Shell shell, String recordName, String fieldName) throws com.ibm.etools.systems.core.messages.SystemMessageException
recordName
- The name of the record for this database for which the field information
is to be returned.fieldName
- The name of the field(s) to retrieve. This can be a generic name such as A*
com.ibm.etools.systems.core.messages.SystemMessageException
public int getCcsid() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public int getRecordLength() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String getEncoding() throws Exception
Exception
public boolean isDBCS() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean exists() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public ISeriesMember createSourceMember(Shell shell, String mbrName, String mbrType, String mbrText) throws com.ibm.etools.systems.core.messages.SystemMessageException
a
- SystemMessageException wrapping a SystemMessage wrapping the host error message the resulted when attempting to create the member
com.ibm.etools.systems.core.messages.SystemMessageException
public void showMembersInTable(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public void showFieldsInTable(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public static void showMembersInTable(Shell shell, ISeriesConnection conn400, String libName, String fileName) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public static void showFieldsInTable(Shell shell, ISeriesConnection conn400, String libName, String fileName) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String getAccessPathType() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isAlternateSequence() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public int getBasedOnCount() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String getBasedOnFiles() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isDynamicSelect() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isIgcField() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isIgcLiteral() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isKeyedAccessPath() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isSelectOmit() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public boolean isJoinLogicalFile() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String getLangId() throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String getFileSubType()
getFileSubType
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile
|
iSeries Remote Systems v6.0.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |