iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.core.dstore.miners
Class AbstractISeriesMiner

java.lang.Object
  extended bycom.ibm.etools.systems.dstore.core.miners.miner.Miner
      extended bycom.ibm.etools.iseries.core.dstore.miners.AbstractISeriesMiner
All Implemented Interfaces:
com.ibm.etools.systems.dstore.core.model.ISchemaExtender
Direct Known Subclasses:
CommandMiner, JobMiner, NativeFileSystemMiner

public abstract class AbstractISeriesMiner
extends com.ibm.etools.systems.dstore.core.miners.miner.Miner


Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.systems.dstore.core.miners.miner.Miner
_dataStore, _dependencies, _minerData, _minerElement, _minerTransient, _name, _resourceBundle, _value
 
Constructor Summary
AbstractISeriesMiner()
           
 
Method Summary
 String getVersion()
          Returns the version of this miner The expected format for this is ".."
protected  void handleException(com.ibm.etools.systems.dstore.core.model.DataElement status, Exception exception)
          Central place for handling error conditions (exceptions) when executing command requests in the miners.
protected  com.ibm.etools.systems.dstore.core.model.DataElement updateInformationFlag(com.ibm.etools.systems.dstore.core.model.DataElement node, char flag)
          For some records we use the value field to store a flag to keep track of which information has been retrieved for that record.
protected  com.ibm.etools.systems.dstore.core.model.DataElement updateOrCreateNode(com.ibm.etools.systems.dstore.core.model.DataElement parent, String type, String name, String source)
           
protected  com.ibm.etools.systems.dstore.core.model.DataElement updateOrCreateNode(com.ibm.etools.systems.dstore.core.model.DataElement parent, String type, String name, String source, String value)
           
 
Methods inherited from class com.ibm.etools.systems.dstore.core.miners.miner.Miner
command, createAbstractCommandDescriptor, createAbstractObjectDescriptor, createAbstractObjectDescriptor, createAbstractRelationship, createCommandDescriptor, createCommandDescriptor, createObjectDescriptor, createObjectDescriptor, createReference, createRelationDescriptor, finish, getCommandArgument, getCommandName, getCommandStatus, getDependencies, getExternalLoader, getLocalizedString, getMinerData, getMinerDependencies, getMinerElement, getMinerTransient, getName, getNumberOfCommandArguments, getResourceBundle, getSchemaRoot, getValue, handleCommand, isConnected, isInitialized, load, load, makeTransient, setDataStore, setExternalLoader, updateMinerInfo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.etools.systems.dstore.core.model.ISchemaExtender
extendSchema
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

AbstractISeriesMiner

public AbstractISeriesMiner()
Method Detail

updateOrCreateNode

protected com.ibm.etools.systems.dstore.core.model.DataElement updateOrCreateNode(com.ibm.etools.systems.dstore.core.model.DataElement parent,
                                                                                  String type,
                                                                                  String name,
                                                                                  String source,
                                                                                  String value)

updateOrCreateNode

protected com.ibm.etools.systems.dstore.core.model.DataElement updateOrCreateNode(com.ibm.etools.systems.dstore.core.model.DataElement parent,
                                                                                  String type,
                                                                                  String name,
                                                                                  String source)

updateInformationFlag

protected com.ibm.etools.systems.dstore.core.model.DataElement updateInformationFlag(com.ibm.etools.systems.dstore.core.model.DataElement node,
                                                                                     char flag)
For some records we use the value field to store a flag to keep track of which information has been retrieved for that record.


handleException

protected void handleException(com.ibm.etools.systems.dstore.core.model.DataElement status,
                               Exception exception)
Central place for handling error conditions (exceptions) when executing command requests in the miners. This method extracts the message out of the exception and updates the status element of the command with the correct error code and creates a childe containing the error message for the front end to handle / display to the user.

Parameters:
status - The DataElement status object for the current command
exception - The exception that occured during processing
Since:
WDSC 5.1.2

getVersion

public String getVersion()
Returns the version of this miner The expected format for this is ".."


iSeries Remote Systems
v6.0.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.