PollingInfo (Unidata IDV API v6.3)

java.lang.Object
- ucar.unidata.util.PollingInfo

All Implemented Interfaces:

java.lang.Cloneable
```
public class PollingInfo
extends java.lang.Object
implements java.lang.Cloneable
```
Class PollingInfo Holds the state that controls the FilePoller

Version:

$Revision: 1.24 $

Author:

IDV Development Team

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MODE_ABSDATERANGE` polling mode
`static int`	`MODE_COUNT` polling mode
`static int`	`MODE_NONEWFILES` polling mode
`static int`	`MODE_RELDATERANGE` polling mode
`static java.lang.String[]`	`MODELABELS` polling mode
`static int[]`	`MODES` polling mode

Constructor Summary

Constructors
Constructor and Description
`PollingInfo()` Constructor
`PollingInfo(boolean isActive)` Constructor
`PollingInfo(long interval, boolean isActive)` Constructor
`PollingInfo(java.lang.String filePath, long interval, java.lang.String filePattern, boolean isActive)` Constructor
`PollingInfo(java.lang.String filePath, long interval, java.lang.String filePattern, boolean isActive, boolean isHiddenOk)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`applyProperties()` _more_
`void`	`checkPattern()` _more_
`PollingInfo`	`cloneMe()` Clone me
`boolean`	`doILookForNewFiles()` _more_
`boolean`	`equals(java.lang.Object object)` _more_
`javax.swing.JCheckBox`	`getActiveWidget()` _more_
`long`	`getDateRange()` Get the DateRange property.
`javax.swing.JTextField`	`getDateRangeWidget()` _more_
`java.lang.String`	`getFile()` Get the filePath property.
`int`	`getFileCount()` Get the FileCount property.
`javax.swing.JComboBox`	`getFileCountWidget()` _more_
`javax.swing.JComboBox`	`getFileCountWidget(int[] values)` _more_
`java.util.List`	`getFilePaths()` Get the FilePaths property.
`javax.swing.JTextField`	`getFilePathWidget()` _more_
`java.lang.String`	`getFilePattern()` Get the filePattern property.
`java.util.List`	`getFiles()` _more_
`boolean`	`getForFiles()` Get the ForFiles property.
`javax.swing.JCheckBox`	`getHiddenWidget()` _more_
`long`	`getInterval()` Get the interval property.
`javax.swing.JTextField`	`getIntervalWidget()` _more_
`boolean`	`getIsActive()` Get the isActive property.
`boolean`	`getIsHiddenOk()` Get the isHiddenOk property.
`int`	`getMode()` Get the Mode property.
`java.lang.String`	`getName()` Get the Name property.
`javax.swing.JTextField`	`getNameWidget()` _more_
`javax.swing.JTextField`	`getPatternWidget()` _more_
`void`	`getPropertyComponents(java.util.List comps, boolean includeName, boolean includeFileCount)` _more_
`boolean`	`hasFilePattern()` _more_
`boolean`	`hasFiles()` _more_
`boolean`	`hasName()` _more_
`boolean`	`isADirectory()` _more_
`static void`	`main(java.lang.String[] args)` _more_
`void`	`setDateRange(long value)` Set the DateRange property.
`void`	`setDontLookForNewFiles()` _more_
`void`	`setFileCount(int value)` Set the FileCount property.
`void`	`setFilePath(java.lang.String newValue)` Deprecated. Use setFilePaths
`void`	`setFilePaths(java.util.List value)` Set the FilePaths property.
`void`	`setFilePattern(java.lang.String newValue)` Set the filePattern property.
`void`	`setForFiles(boolean value)` Set the ForFiles property.
`void`	`setInterval(long newValue)` Set the interval property.
`void`	`setIsActive(boolean newValue)` Set the isActive property.
`void`	`setIsHiddenOk(boolean newValue)` Set the isHiddenOk property.
`void`	`setMode(int value)` Set the Mode property.
`void`	`setName(java.lang.String value)` Set the Name property.
`java.lang.String`	`toString()` Get a String representation of this object

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MODE_NONEWFILES
```
public static final int MODE_NONEWFILES
```
    polling mode
    
    See Also:
    
    Constant Field Values
  - MODE_COUNT
```
public static final int MODE_COUNT
```
    polling mode
    
    See Also:
    
    Constant Field Values
  - MODE_RELDATERANGE
```
public static final int MODE_RELDATERANGE
```
    polling mode
    
    See Also:
    
    Constant Field Values
  - MODE_ABSDATERANGE
```
public static final int MODE_ABSDATERANGE
```
    polling mode
    
    See Also:
    
    Constant Field Values
  - MODES
```
public static final int[] MODES
```
    polling mode
  - MODELABELS
```
public static final java.lang.String[] MODELABELS
```
    polling mode
- Constructor Detail
  - PollingInfo
```
public PollingInfo()
```
    Constructor
  - PollingInfo
```
public PollingInfo(boolean isActive)
```
    Constructor
    
    Parameters:
    
    isActive - The isActive parameter
  - PollingInfo
```
public PollingInfo(long interval,
                   boolean isActive)
```
    Constructor
    
    Parameters:
    
    interval - The interval parameter
    
    isActive - The isActive parameter
  - PollingInfo
```
public PollingInfo(java.lang.String filePath,
                   long interval,
                   java.lang.String filePattern,
                   boolean isActive)
```
    Constructor
    
    Parameters:
    
    filePath - The filePath parameter
    
    interval - The interval parameter
    
    filePattern - The filePattern parameter
    
    isActive - The isActive parameter
  - PollingInfo
```
public PollingInfo(java.lang.String filePath,
                   long interval,
                   java.lang.String filePattern,
                   boolean isActive,
                   boolean isHiddenOk)
```
    Constructor
    
    Parameters:
    
    filePath - The filePath parameter
    
    interval - The interval parameter
    
    filePattern - The filePattern parameter
    
    isActive - The isActive parameter
    
    isHiddenOk - poll on hidden files as well
- Method Detail
  - cloneMe
```
public PollingInfo cloneMe()
```
    Clone me
    
    Returns:
    
    Cloned version of this
  - setDontLookForNewFiles
```
public void setDontLookForNewFiles()
```
    _more_
  - doILookForNewFiles
```
public boolean doILookForNewFiles()
```
    _more_
    
    Returns:
    
    _more_
  - getPropertyComponents
```
public void getPropertyComponents(java.util.List comps,
                                  boolean includeName,
                                  boolean includeFileCount)
```
    _more_
    
    Parameters:
    
    comps - _more_
    
    includeName - _more_
    
    includeFileCount - _more_
  - checkPattern
```
public void checkPattern()
```
    _more_
  - getHiddenWidget
```
public javax.swing.JCheckBox getHiddenWidget()
```
    _more_
    
    Returns:
    
    _more_
  - getActiveWidget
```
public javax.swing.JCheckBox getActiveWidget()
```
    _more_
    
    Returns:
    
    _more_
  - getPatternWidget
```
public javax.swing.JTextField getPatternWidget()
```
    _more_
    
    Returns:
    
    _more_
  - getIntervalWidget
```
public javax.swing.JTextField getIntervalWidget()
```
    _more_
    
    Returns:
    
    _more_
  - getFilePathWidget
```
public javax.swing.JTextField getFilePathWidget()
```
    _more_
    
    Returns:
    
    _more_
  - getNameWidget
```
public javax.swing.JTextField getNameWidget()
```
    _more_
    
    Returns:
    
    _more_
  - getDateRangeWidget
```
public javax.swing.JTextField getDateRangeWidget()
```
    _more_
    
    Returns:
    
    _more_
  - getFileCountWidget
```
public javax.swing.JComboBox getFileCountWidget()
```
    _more_
    
    Returns:
    
    _more_
  - getFileCountWidget
```
public javax.swing.JComboBox getFileCountWidget(int[] values)
```
    _more_
    
    Parameters:
    
    values - _more_
    
    Returns:
    
    _more_
  - isADirectory
```
public boolean isADirectory()
```
    _more_
    
    Returns:
    
    _more_
  - hasFiles
```
public boolean hasFiles()
```
    _more_
    
    Returns:
    
    _more_
  - applyProperties
```
public boolean applyProperties()
```
    _more_
    
    Returns:
    
    _more_
  - getFiles
```
public java.util.List getFiles()
```
    _more_
    
    Returns:
    
    _more_
  - getInterval
```
public long getInterval()
```
    Get the interval property.
    
    Returns:
    
    The interval property.
  - setInterval
```
public void setInterval(long newValue)
```
    Set the interval property.
    
    Parameters:
    
    newValue - The new vaue for the interval property.
  - getFile
```
public java.lang.String getFile()
```
    Get the filePath property.
    
    Returns:
    
    The filePath property.
  - setFilePath
```
public void setFilePath(java.lang.String newValue)
```
    Deprecated. Use setFilePaths
    
    Set the filePath property.
    
    Parameters:
    
    newValue - The new vaue for the filePath property.
  - getFilePattern
```
public java.lang.String getFilePattern()
```
    Get the filePattern property.
    
    Returns:
    
    The filePattern property.
  - hasName
```
public boolean hasName()
```
    _more_
    
    Returns:
    
    _more_
  - hasFilePattern
```
public boolean hasFilePattern()
```
    _more_
    
    Returns:
    
    _more_
  - setFilePattern
```
public void setFilePattern(java.lang.String newValue)
```
    Set the filePattern property.
    
    Parameters:
    
    newValue - The new vaue for the filePattern property.
  - getIsActive
```
public boolean getIsActive()
```
    Get the isActive property.
    
    Returns:
    
    The isActive property.
  - setIsActive
```
public void setIsActive(boolean newValue)
```
    Set the isActive property.
    
    Parameters:
    
    newValue - The new vaue for the isActive property.
  - getIsHiddenOk
```
public boolean getIsHiddenOk()
```
    Get the isHiddenOk property.
    
    Returns:
    
    The isHiddenOk property.
  - setIsHiddenOk
```
public void setIsHiddenOk(boolean newValue)
```
    Set the isHiddenOk property.
    
    Parameters:
    
    newValue - The new vaue for the isHiddenOk property.
  - toString
```
public java.lang.String toString()
```
    Get a String representation of this object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation
  - equals
```
public boolean equals(java.lang.Object object)
```
    _more_
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    object - _more_
    
    Returns:
    
    _more_
  - setForFiles
```
public void setForFiles(boolean value)
```
    Set the ForFiles property.
    
    Parameters:
    
    value - The new value for ForFiles
  - getForFiles
```
public boolean getForFiles()
```
    Get the ForFiles property.
    
    Returns:
    
    The ForFiles
  - setMode
```
public void setMode(int value)
```
    Set the Mode property.
    
    Parameters:
    
    value - The new value for Mode
  - getMode
```
public int getMode()
```
    Get the Mode property.
    
    Returns:
    
    The Mode
  - setFileCount
```
public void setFileCount(int value)
```
    Set the FileCount property.
    
    Parameters:
    
    value - The new value for FileCount
  - getFileCount
```
public int getFileCount()
```
    Get the FileCount property.
    
    Returns:
    
    The FileCount
  - setDateRange
```
public void setDateRange(long value)
```
    Set the DateRange property.
    
    Parameters:
    
    value - The new value for DateRange
  - getDateRange
```
public long getDateRange()
```
    Get the DateRange property.
    
    Returns:
    
    The DateRange
  - main
```
public static void main(java.lang.String[] args)
```
    _more_
    
    Parameters:
    
    args - _more_
  - setName
```
public void setName(java.lang.String value)
```
    Set the Name property.
    
    Parameters:
    
    value - The new value for Name
  - getName
```
public java.lang.String getName()
```
    Get the Name property.
    
    Returns:
    
    The Name
  - setFilePaths
```
public void setFilePaths(java.util.List value)
```
    Set the FilePaths property.
    
    Parameters:
    
    value - The new value for FilePaths
  - getFilePaths
```
public java.util.List getFilePaths()
```
    Get the FilePaths property.
    
    Returns:
    
    The FilePaths

Class PollingInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODE_NONEWFILES

MODE_COUNT

MODE_RELDATERANGE

MODE_ABSDATERANGE

MODES

MODELABELS

Constructor Detail

PollingInfo

PollingInfo

PollingInfo

PollingInfo

PollingInfo

Method Detail

cloneMe

setDontLookForNewFiles

doILookForNewFiles

getPropertyComponents

checkPattern

getHiddenWidget

getActiveWidget

getPatternWidget

getIntervalWidget

getFilePathWidget

getNameWidget

getDateRangeWidget

getFileCountWidget

getFileCountWidget

isADirectory

hasFiles

applyProperties

getFiles

getInterval

setInterval

getFile

setFilePath

getFilePattern

hasName

hasFilePattern

setFilePattern

getIsActive

setIsActive

getIsHiddenOk

setIsHiddenOk

toString

equals

setForFiles

getForFiles

setMode

getMode

setFileCount

getFileCount

setDateRange

getDateRange

main

setName

getName

setFilePaths

getFilePaths