Class LocalFileSearchWithTimestampConstraints
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.flow.source.filesystemsearch.AbstractFileSystemSearchlet
-
- adams.flow.source.filesystemsearch.AbstractLocalDirectoryListerBasedSearchlet
-
- adams.flow.source.filesystemsearch.LocalFileSearch
-
- adams.flow.source.filesystemsearch.LocalFileSearchWithTimestampConstraints
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter<AbstractFileSystemSearchlet>
,SizeOfHandler
,Stoppable
,StoppableWithFeedback
,FlowContextHandler
,Serializable
public class LocalFileSearchWithTimestampConstraints extends LocalFileSearch
Searches only for files.
Allows to further restrict the search using a timestamp window ('last modified') that the files must satisfy.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-directory <adams.core.io.PlaceholderDirectory> (property: directory) The directory to search for files. default: ${CWD}
-max-items <int> (property: maxItems) The maximum number of files to return (<= 0 is unlimited). default: -1
-regexp <adams.core.base.BaseRegExp> (property: regExp) The regular expression that the files must match (empty string matches all ). default:
-sorting <NO_SORTING|SORT_BY_NAME|SORT_BY_LAST_MODIFIED> (property: sorting) The type of sorting to perform. default: NO_SORTING
-descending <boolean> (property: sortDescending) If set to true, the files are sorted in descending manner. default: false
-recursive <boolean> (property: recursive) Whether to search recursively or not. default: false
-max-depth <int> (property: maxDepth) The maximum depth to search in recursive mode (1 = only watch directory, -1 = infinite). default: -1
-min-timestamp <adams.core.base.BaseDateTime> (property: minTimestamp) The minimum 'last modified' timestamp that the files can have. default: -INF
-max-timestamp <adams.core.base.BaseDateTime> (property: maxTimestamp) The maximum 'last modified' timestamp that the files can have. default: +INF
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class adams.flow.source.filesystemsearch.AbstractLocalDirectoryListerBasedSearchlet
m_Lister
-
Fields inherited from class adams.flow.source.filesystemsearch.AbstractFileSystemSearchlet
m_FlowContext, m_Stopped
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description LocalFileSearchWithTimestampConstraints()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.BaseDateTime
getMaxTimestamp()
Returns the maximum file timestamp that the files have to have.BaseDateTime
getMinTimestamp()
Returns the minimum 'last modified' timestamp that the files have to have.String
globalInfo()
Returns a string describing the object.String
maxTimestampTipText()
Returns the tip text for this property.String
minTimestampTipText()
Returns the tip text for this property.void
setMaxTimestamp(BaseDateTime value)
Sets the maximum 'last modified' timestamp that the files have to have.void
setMinTimestamp(BaseDateTime value)
Sets the minimum 'last modified' timestamp that the files have to have.-
Methods inherited from class adams.flow.source.filesystemsearch.LocalFileSearch
directoryTipText, getDirectory, getMaxDepth, getMaxItems, getQuickInfo, getRecursive, getRegExp, getSortDescending, getSorting, getUseRelativePaths, initialize, maxDepthTipText, maxItemsTipText, recursiveTipText, regExpTipText, setDirectory, setMaxDepth, setMaxItems, setRecursive, setRegExp, setSortDescending, setSorting, setUseRelativePaths, sortDescendingTipText, sortingTipText, useRelativePathsTipText
-
Methods inherited from class adams.flow.source.filesystemsearch.AbstractLocalDirectoryListerBasedSearchlet
doSearch, setLoggingLevel, stopExecution
-
Methods inherited from class adams.flow.source.filesystemsearch.AbstractFileSystemSearchlet
check, getFlowContext, isStopped, search, setFlowContext, shallowCopy, shallowCopy
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Overrides:
globalInfo
in classLocalFileSearch
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classLocalFileSearch
-
setMinTimestamp
public void setMinTimestamp(BaseDateTime value)
Sets the minimum 'last modified' timestamp that the files have to have.- Parameters:
value
- the minimum timestamp- See Also:
LocalDirectoryLister.setMinFileTimestamp(BaseDateTime)
-
getMinTimestamp
public BaseDateTime getMinTimestamp()
Returns the minimum 'last modified' timestamp that the files have to have.- Returns:
- the minimum timestamp
- See Also:
LocalDirectoryLister.getMinFileTimestamp()
-
minTimestampTipText
public String minTimestampTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setMaxTimestamp
public void setMaxTimestamp(BaseDateTime value)
Sets the maximum 'last modified' timestamp that the files have to have.- Parameters:
value
- the maximum timestamp- See Also:
LocalDirectoryLister.setMaxFileTimestamp(BaseDateTime)
-
getMaxTimestamp
public BaseDateTime getMaxTimestamp()
Returns the maximum file timestamp that the files have to have.- Returns:
- the maximum timestamp
- See Also:
LocalDirectoryLister.getMaxFileTimestamp()
-
maxTimestampTipText
public String maxTimestampTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
-