ncsa.tools.ogrescript.trebuchet.tasks.cache
Class Cache

java.lang.Object
  extended byncsa.tools.ogrescript.OgreScriptElement
      extended byncsa.tools.ogrescript.tasks.OgreScriptBaseTask
          extended byncsa.tools.ogrescript.tasks.OgreScriptTask
              extended byncsa.tools.ogrescript.trebuchet.tasks.cache.Cache
All Implemented Interfaces:
IIdentifiable, ITask, UserFacing

public class Cache
extends OgreScriptTask

A cache object can be obtained in three ways: (a) from a CacheBasedOperation (read-only); (b) from a cache file; (c) created from a header. In the latter case, one or more of the URIs must be set. If a pattern or configuration is given, these will be included in the header. The booleans 'copyCache' and 'readOnly' default to false and true, respectively.

Author:
arossi

Field Summary
static java.lang.String TAG_SELF
           
 
Fields inherited from class ncsa.tools.ogrescript.tasks.OgreScriptBaseTask
TAG_EXT_PT, TAG_REQUIRED
 
Constructor Summary
Cache()
           
 
Method Summary
 org.eclipse.core.runtime.Plugin getPlugin()
           
 void setConfiguration(TrebuchetConfiguration configuration)
           
 void setCopyCache(boolean copyCache)
           
 void setFile(java.io.File file)
           
 void setOperation(CacheBasedOperation operation)
           
 void setPattern(UriPattern pattern)
           
 void setReadOnly(boolean readOnly)
           
 void setSourceBaseUri(java.lang.String sourceBase)
           
 void setTargetUri(java.lang.String targetDir)
           
 void setTmpDir(java.lang.String tmpDir)
           
 
Methods inherited from class ncsa.tools.ogrescript.tasks.OgreScriptTask
addReturnValue, getReturnValues, setReturnValues
 
Methods inherited from class ncsa.tools.ogrescript.tasks.OgreScriptBaseTask
execute, getInstanceId, getScript, getTaskId, getTaskName, setEnvironment, setInstanceId, setScript, setTaskId, setTaskName, toString
 
Methods inherited from class ncsa.tools.ogrescript.OgreScriptElement
asElement, initializeFromElement
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ncsa.tools.common.UserFacing
asElement, initializeFromElement
 

Field Detail

TAG_SELF

public static final java.lang.String TAG_SELF
See Also:
Constant Field Values
Constructor Detail

Cache

public Cache()
Method Detail

setFile

public void setFile(java.io.File file)

setOperation

public void setOperation(CacheBasedOperation operation)

setPattern

public void setPattern(UriPattern pattern)

setSourceBaseUri

public void setSourceBaseUri(java.lang.String sourceBase)

setTargetUri

public void setTargetUri(java.lang.String targetDir)

setTmpDir

public void setTmpDir(java.lang.String tmpDir)

setCopyCache

public void setCopyCache(boolean copyCache)

setReadOnly

public void setReadOnly(boolean readOnly)

setConfiguration

public void setConfiguration(TrebuchetConfiguration configuration)

getPlugin

public org.eclipse.core.runtime.Plugin getPlugin()
Specified by:
getPlugin in interface IIdentifiable
Overrides:
getPlugin in class OgreScriptBaseTask