|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.systems.dstore.core.miners.miner.Miner
com.ibm.etools.systems.universal.miners.UniversalFileSystemMiner
Field Summary | |
---|---|
protected ArchiveHandlerManager |
_archiveHandlerManager
|
protected HashMap |
_cancellableThreads
|
static String |
CLASSNAME
|
static String |
copyright
|
protected String |
filterString
|
protected boolean |
showHidden
|
Fields inherited from class com.ibm.etools.systems.dstore.core.miners.miner.Miner |
---|
_dataStore, _dependencies, _minerData, _minerElement, _minerTransient, _name, _resourceBundle, _value, Copyright |
Constructor Summary | |
---|---|
UniversalFileSystemMiner()
|
Method Summary | |
---|---|
protected void |
createDataElement(DataStore ds,
DataElement subject,
File[] list,
String queryType,
String filter,
int include)
|
protected void |
createDataElement(DataStore ds,
DataElement subject,
File[] list,
String queryType,
String filter,
int include,
String[] types)
Method to create the DataElement object in the datastore. |
protected void |
createDataElement(DataStore ds,
DataElement subject,
VirtualChild[] list,
String filter,
String rootPath,
String virtualPath)
Method to create the DataElement object in the datastore out of a list of VirtualChildren |
void |
deleteDir(File fileObj,
DataElement status)
Delete directory and its children. |
void |
extendSchema(DataElement schemaRoot)
Add this tool's schema to the global DataStore schema. |
void |
finish()
Shuts down the miner and cleans up it's meta-information. |
AbsoluteVirtualPath |
getAbsoluteVirtualPath(String path)
|
ISystemArchiveHandler |
getArchiveHandlerFor(String archivePath)
|
protected String |
getClassificationString(String s)
Method to obtain the classificatoin string of file or folder. |
protected int |
getDepth(String s)
Method to obtain the depth for a search |
protected FileClassifier |
getFileClassifier(DataElement subject)
|
protected DataElement |
getFileElement(DataElement subject,
File file)
|
protected String |
getFilterString(String s)
Method to obtain the filter string of file or folder. |
protected InputStream |
getInputStreamForFile(String filename)
|
protected boolean |
getShowHiddenFlag(String s)
Method to obtain the show Hidden flag for file or folder. |
String |
getVersion()
Returns the version of this miner The expected format for this is " |
DataElement |
handleCancel(DataElement subject,
DataElement status)
|
DataElement |
handleCommand(DataElement theElement)
Handle commands that are routed to this miner. |
DataElement |
handleCopy(DataElement targetFolder,
DataElement sourceFile,
DataElement nameObj,
DataElement status)
|
DataElement |
handleCreateFile(DataElement subject,
DataElement status,
String queryType)
Method to create a new file. |
DataElement |
handleCreateFolder(DataElement subject,
DataElement status,
String queryType)
Method to create a new folder. |
DataElement |
handleCreateVirtualFile(DataElement subject,
DataElement status,
String type)
|
DataElement |
handleCreateVirtualFolder(DataElement subject,
DataElement status,
String type)
|
DataElement |
handleDelete(DataElement subject,
DataElement status)
Method to Delete a file or folder. |
DataElement |
handleDeleteFromArchive(DataElement subject,
DataElement status)
|
protected DataElement |
handleDownload(DataElement theElement,
DataElement status)
Method to download a file. |
DataElement |
handleGetOSType(DataElement subject,
DataElement status)
Method to retrieve the OS that the miner is running. |
protected DataElement |
handleQueryAdvanceProperty(DataElement subject,
DataElement status)
Method to query advance properties. |
DataElement |
handleQueryAll(DataElement subject,
DataElement attributes,
DataElement status,
String queryType,
boolean caseSensitive)
Method to list the files and folders for a given filter. |
DataElement |
handleQueryAllArchive(DataElement subject,
DataElement attributes,
DataElement status,
boolean caseSensitive,
boolean foldersOnly)
|
protected DataElement |
handleQueryBasicProperty(DataElement subject,
DataElement status)
Method to Retrieve properties of the file or folder. |
protected DataElement |
handleQuerycanWriteProperty(DataElement subject,
DataElement status)
Method to Retrieve canWrite property of the file or folder. |
protected DataElement |
handleQueryClassName(DataElement subject,
DataElement status)
Retrieve the fully qualified class name (including package) for the specified .class file. |
protected DataElement |
handleQueryEncoding(DataElement subject,
DataElement status)
Get the system encoding |
protected DataElement |
handleQueryExists(DataElement subject,
DataElement status,
String queryType)
Method to query existence of the file or folder. |
protected DataElement |
handleQueryFileClassification(DataElement subject,
DataElement status)
|
DataElement |
handleQueryFiles(DataElement subject,
DataElement attributes,
DataElement status,
String queryType,
boolean caseSensitive)
Method to list the files for a given filter. |
DataElement |
handleQueryFolders(DataElement subject,
DataElement attributes,
DataElement status,
String queryType,
boolean caseSensitive)
Method to list the folders for a given filter. |
DataElement |
handleQueryGetRemoteObject(DataElement subject,
DataElement status,
String queryType)
Method to get remote object |
protected DataElement |
handleQueryQualifiedClassName(DataElement subject,
DataElement status)
Retrieve the fully qualified class name (including package) for a class file. |
DataElement |
handleQueryRoots(DataElement subject,
DataElement status)
Method to list the roots. |
protected DataElement |
handleQueryUnusedPort(DataElement subject,
DataElement status)
Get an unused port number. |
DataElement |
handleRename(DataElement subject,
DataElement status)
Method to Rename a file or folder. |
DataElement |
handleSearch(DataElement theElement,
DataElement status,
String queryType,
boolean fileNamesCaseSensitive)
Method to do a search. |
DataElement |
handleSetLastModified(DataElement subject,
DataElement status)
Method to set LastModified to a file or folder. |
DataElement |
handleSetReadOnly(DataElement subject,
DataElement status)
Method to set ReadOnly to a file or folder. |
protected void |
internalQueryAll(DataElement subject,
File fileobj,
String queryType,
String filter,
boolean caseSensitive,
int inclusion)
|
protected boolean |
isSpecialChar(char c)
Checks whether the given character is a special character in the shell. |
void |
load()
Default method that gets called on a Miner when it is loaded. |
String |
setProperties(File fileObj)
|
String |
setProperties(File fileObj,
boolean doArchiveProperties)
Method to obtain the properties of file or folder. |
String |
setProperties(VirtualChild fileObj)
|
DataElement |
statusCancelled(DataElement status)
Cancel status. |
DataElement |
statusDone(DataElement status)
Complete status. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected String filterString
protected ArchiveHandlerManager _archiveHandlerManager
protected boolean showHidden
public static final String copyright
public static final String CLASSNAME
protected HashMap _cancellableThreads
Constructor Detail |
public UniversalFileSystemMiner()
Method Detail |
protected FileClassifier getFileClassifier(DataElement subject)
public DataElement handleCommand(DataElement theElement)
Miner
handleCommand
in class Miner
theElement
- an instance of a command containing a tree of argumentsMiner.handleCommand(DataElement)
public void deleteDir(File fileObj, DataElement status)
public DataElement handleSearch(DataElement theElement, DataElement status, String queryType, boolean fileNamesCaseSensitive)
public DataElement handleCancel(DataElement subject, DataElement status)
public DataElement handleQueryAll(DataElement subject, DataElement attributes, DataElement status, String queryType, boolean caseSensitive)
protected void internalQueryAll(DataElement subject, File fileobj, String queryType, String filter, boolean caseSensitive, int inclusion)
public DataElement handleQueryFiles(DataElement subject, DataElement attributes, DataElement status, String queryType, boolean caseSensitive)
public DataElement handleQueryFolders(DataElement subject, DataElement attributes, DataElement status, String queryType, boolean caseSensitive)
public DataElement handleQueryRoots(DataElement subject, DataElement status)
public DataElement handleDelete(DataElement subject, DataElement status)
public DataElement handleRename(DataElement subject, DataElement status)
public DataElement handleCreateFile(DataElement subject, DataElement status, String queryType)
public DataElement handleCreateFolder(DataElement subject, DataElement status, String queryType)
public DataElement handleSetReadOnly(DataElement subject, DataElement status)
public DataElement handleSetLastModified(DataElement subject, DataElement status)
protected DataElement handleQueryBasicProperty(DataElement subject, DataElement status)
protected DataElement handleQuerycanWriteProperty(DataElement subject, DataElement status)
protected DataElement handleQueryAdvanceProperty(DataElement subject, DataElement status)
protected DataElement handleQueryFileClassification(DataElement subject, DataElement status)
protected DataElement handleQueryExists(DataElement subject, DataElement status, String queryType)
public DataElement handleQueryGetRemoteObject(DataElement subject, DataElement status, String queryType)
protected DataElement getFileElement(DataElement subject, File file)
protected void createDataElement(DataStore ds, DataElement subject, File[] list, String queryType, String filter, int include)
protected void createDataElement(DataStore ds, DataElement subject, File[] list, String queryType, String filter, int include, String[] types)
protected void createDataElement(DataStore ds, DataElement subject, VirtualChild[] list, String filter, String rootPath, String virtualPath)
public String setProperties(File fileObj)
public String setProperties(File fileObj, boolean doArchiveProperties)
public String setProperties(VirtualChild fileObj)
protected String getClassificationString(String s)
protected String getFilterString(String s)
protected boolean getShowHiddenFlag(String s)
protected int getDepth(String s)
protected DataElement handleDownload(DataElement theElement, DataElement status)
protected DataElement handleQueryEncoding(DataElement subject, DataElement status)
protected DataElement handleQueryUnusedPort(DataElement subject, DataElement status)
public DataElement statusDone(DataElement status)
public DataElement statusCancelled(DataElement status)
public void load()
Miner
load
in class Miner
Miner.load()
public void finish()
Miner
finish
in class Miner
protected DataElement handleQueryClassName(DataElement subject, DataElement status)
protected DataElement handleQueryQualifiedClassName(DataElement subject, DataElement status)
public DataElement handleGetOSType(DataElement subject, DataElement status)
protected InputStream getInputStreamForFile(String filename) throws IOException
IOException
public void extendSchema(DataElement schemaRoot)
ISchemaExtender
extendSchema
in interface ISchemaExtender
schemaRoot
- the descriptor rootISchemaExtender.extendSchema(DataElement)
public AbsoluteVirtualPath getAbsoluteVirtualPath(String path)
public DataElement handleDeleteFromArchive(DataElement subject, DataElement status)
public DataElement handleQueryAllArchive(DataElement subject, DataElement attributes, DataElement status, boolean caseSensitive, boolean foldersOnly)
public ISystemArchiveHandler getArchiveHandlerFor(String archivePath)
public DataElement handleCreateVirtualFile(DataElement subject, DataElement status, String type)
public DataElement handleCreateVirtualFolder(DataElement subject, DataElement status, String type)
public DataElement handleCopy(DataElement targetFolder, DataElement sourceFile, DataElement nameObj, DataElement status)
protected boolean isSpecialChar(char c)
c
- the character to check.
true
if the character is a special character, false
otherwise.public String getVersion()
Miner
getVersion
in class Miner
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |