WalkImageSequence

java.lang.Object
- org.autoplot.pngwalk.WalkImageSequence

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener
```
public class WalkImageSequence
extends java.lang.Object
implements java.beans.PropertyChangeListener
```
This class maintains a list of WalkImages and provides functionality for navigating through it. Whenever the current index is changed, whether explicitly set or via one of the navigation functions, a PropertyChangeEvent is fired. This allows UI code to control the index and view code to respond.

Access is also provided to the WalkImage objects so that view code can retrieve images, thumbnails, etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_BADGE_CHANGE`
`static java.lang.String`	`PROP_IMAGE_LOADED`
`static java.lang.String`	`PROP_INDEX`
`static java.lang.String`	`PROP_SELECTED_INDECES`
`static java.lang.String`	`PROP_SEQUENCE_CHANGED`
`static java.lang.String`	`PROP_STATUS`
`static java.lang.String`	`PROP_THUMB_LOADED`
`static java.lang.String`	`PROP_TIMERANGE`
`static java.lang.String`	`PROP_USESUBRANGE`
`protected java.lang.String`	`status`

Constructor Summary

Constructors
Constructor and Description

WalkImageSequence(java.lang.String template)
Create an image sequence based on a URI template.

Constructors
Constructor and Description
`WalkImageSequence(java.lang.String template)` Create an image sequence based on a URI template.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener l)` things we fire events for: PROP_BADGE_CHANGE and others
`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
`WalkImage`	`currentImage()`
`int`	`findIndex(java.lang.String name)` returns the index of the name, or -1 if the name is not found.
`void`	`first()` Move the index to the first image in the list.
`java.util.List<DatumRange>`	`getActiveSubrange()` return the active subrange of the sequence.
`java.util.List<DatumRange>`	`getAllTimes()` Return a `java.awt.List` of the times associated with this sequence.
`WalkImage`	`getImage(java.net.URI image)` return the WalkImage object for the given URI.
`int`	`getIndex()` Return the current value of the index, where index is that of the displayImages.
`java.net.URI`	`getQCFolder()`
`QualityControlSequence`	`getQualityControlSequence()` this may be null if even though we are using QualityControl, if the user hasn't logged in yet.
`java.util.List<java.lang.Integer>`	`getSelectedIndeces()`
`java.lang.String`	`getSelectedName()` return the name of the selected image.
`java.lang.String`	`getStatus()` get the current status
`java.lang.String`	`getTemplate()` return the template representing the sequence.
`DatumRange`	`getTimerange()` constraint for the limit of the time ranges listed.
`DatumRange`	`getTimeSpan()` Return the time range covered by this sequence.
`WalkImage`	`imageAt(int n)` return the image of the subrange.
`WalkImage`	`imageAtNoSubRange(int n)` get the image in the sequence, regardless of the subrange.
`protected int`	`indexOfSubrange(DatumRange dr)` return the index of the datumRange completely containing this interval.
`void`	`initialLoad()` do the initial listing of the remote filesystem.
`protected void`	`initQualitySequence(java.net.URI qcFolder)` initialize the quality control sequence.
`protected boolean`	`isLimitWarning()`
`boolean`	`isShowMissing()`
`boolean`	`isUseSubRange()`
`void`	`last()` Move the image to the last image in the list.
`void`	`next()` Advance the index to the next image in the list.
`void`	`prev()` Step the index to the previous image in the list.
`void`	`propertyChange(java.beans.PropertyChangeEvent e)`
`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener l)`
`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
`void`	`setActiveSubrange(DatumRange range)` Convenience method for to set the subrange to the items intersecting the given range.
`void`	`setActiveSubrange(int first, int last)` Set the sequence's active subrange to a range from first to last, inclusive.
`void`	`setIndex(int index)` Set the index explicitly.
`void`	`setQCFilter(java.lang.String s)` string containing combination of "opi" meaning that each should be shown.
`void`	`setQCFolder(java.net.URI folder)`
`void`	`setSelectedIndeces(java.util.List<java.lang.Integer> sel)`
`void`	`setShowMissing(boolean showMissing)`
`protected void`	`setStatus(java.lang.String status)` set the current status, which is echoed back to the scientist.
`void`	`setTimerange(DatumRange timerange)` constraint for the limit of the time ranges listed.
`void`	`setUseSubRange(boolean useSubRange)`
`int`	`size()` return the number of images in the sequence.
`void`	`skipBy(int n)` Skip forward or backward by the specified number of images.

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

- Field Detail
  - PROP_INDEX
```
public static final java.lang.String PROP_INDEX
```
    See Also:
    
    Constant Field Values
  - PROP_SELECTED_INDECES
```
public static final java.lang.String PROP_SELECTED_INDECES
```
    See Also:
    
    Constant Field Values
  - PROP_IMAGE_LOADED
```
public static final java.lang.String PROP_IMAGE_LOADED
```
    See Also:
    
    Constant Field Values
  - PROP_THUMB_LOADED
```
public static final java.lang.String PROP_THUMB_LOADED
```
    See Also:
    
    Constant Field Values
  - PROP_USESUBRANGE
```
public static final java.lang.String PROP_USESUBRANGE
```
    See Also:
    
    Constant Field Values
  - PROP_SEQUENCE_CHANGED
```
public static final java.lang.String PROP_SEQUENCE_CHANGED
```
    See Also:
    
    Constant Field Values
  - PROP_BADGE_CHANGE
```
public static final java.lang.String PROP_BADGE_CHANGE
```
    See Also:
    
    Constant Field Values
  - PROP_TIMERANGE
```
public static final java.lang.String PROP_TIMERANGE
```
    See Also:
    
    Constant Field Values
  - status
```
protected java.lang.String status
```
  - PROP_STATUS
```
public static final java.lang.String PROP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WalkImageSequence
```
public WalkImageSequence(java.lang.String template)
```
    Create an image sequence based on a URI template.
    
    Parameters:
    
    template - a template, or null will produce an empty walk sequence.
- Method Detail
  - getTimerange
```
public DatumRange getTimerange()
```
    constraint for the limit of the time ranges listed. Note timespan is what was found. This does not appear to be the current image timerange.
    
    Returns:
  - setTimerange
```
public void setTimerange(DatumRange timerange)
```
    constraint for the limit of the time ranges listed. Note timespan is what was found.
    
    Parameters:
    
    timerange -
  - initialLoad
```
public void initialLoad()
                 throws java.io.IOException
```
    do the initial listing of the remote filesystem. This should not be done on the event thread, and should be done before the sequence is used.
    
    Throws:
    
    java.io.IOException
  - indexOfSubrange
```
protected int indexOfSubrange(DatumRange dr)
```
    return the index of the datumRange completely containing this interval.
    
    Parameters:
    
    dr -
    
    Returns:
    
    -1 if no range contains the subrange, the index of the DatumRange otherwise.
  - isLimitWarning
```
protected boolean isLimitWarning()
```
  - initQualitySequence
```
protected void initQualitySequence(java.net.URI qcFolder)
```
    initialize the quality control sequence.
    
    Parameters:
    
    qcFolder - URI with the password resolved.
  - currentImage
```
public WalkImage currentImage()
```
  - getImage
```
public WalkImage getImage(java.net.URI image)
```
    return the WalkImage object for the given URI.
    
    Parameters:
    
    image - the location
    
    Returns:
    
    the object modeling this image.
  - imageAt
```
public WalkImage imageAt(int n)
```
    return the image of the subrange.
    
    Parameters:
    
    n -
    
    Returns:
  - imageAtNoSubRange
```
public WalkImage imageAtNoSubRange(int n)
```
    get the image in the sequence, regardless of the subrange.
    
    Parameters:
    
    n -
    
    Returns:
  - getQCFolder
```
public java.net.URI getQCFolder()
```
  - setQCFolder
```
public void setQCFolder(java.net.URI folder)
```
  - getQualityControlSequence
```
public QualityControlSequence getQualityControlSequence()
```
    this may be null if even though we are using QualityControl, if the user hasn't logged in yet.
    
    Returns:
  - isShowMissing
```
public boolean isShowMissing()
```
  - setShowMissing
```
public void setShowMissing(boolean showMissing)
```
  - isUseSubRange
```
public boolean isUseSubRange()
```
  - setUseSubRange
```
public void setUseSubRange(boolean useSubRange)
```
  - setActiveSubrange
```
public void setActiveSubrange(int first,
                              int last)
```
    Set the sequence's active subrange to a range from first to last, inclusive. First and last are indices into the list obtained from getAllTimes().
    
    Parameters:
    
    first -
    
    last -
  - setActiveSubrange
```
public void setActiveSubrange(DatumRange range)
```
    Convenience method for to set the subrange to the items intersecting the given range.
    
    Parameters:
    
    range -
  - setQCFilter
```
public void setQCFilter(java.lang.String s)
```
    string containing combination of "opi" meaning that each should be shown. "" will show everything. The list can include:
    - o okay are shown
    - p problem are shown
    - i ignore are shown
    Parameters:
    
    s -
  - getActiveSubrange
```
public java.util.List<DatumRange> getActiveSubrange()
```
    return the active subrange of the sequence. This is the portion of the pngwalk being used.
    
    Returns:
    
    the subrange of the sequence.
    
    See Also:
    
    https://sourceforge.net/p/autoplot/feature-requests/493/
  - getTimeSpan
```
public DatumRange getTimeSpan()
```
    Return the time range covered by this sequence. This is the total range of available images, not any currently displayed subrange. Will be null if no date template was used to create the sequence.
    
    Returns:
    
    the time range covered by this sequence.
  - getAllTimes
```
public java.util.List<DatumRange> getAllTimes()
```
    Return a java.awt.List of the times associated with this sequence. This list will include times associated with missing images, and is not restricted to any currently active subrange.
    
    Returns:
  - getIndex
```
public int getIndex()
```
    Return the current value of the index, where index is that of the displayImages.
    
    Returns:
  - setIndex
```
public void setIndex(int index)
```
    Set the index explicitly.
    
    Parameters:
    
    index -
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - when...
  - setSelectedIndeces
```
public void setSelectedIndeces(java.util.List<java.lang.Integer> sel)
```
  - getSelectedIndeces
```
public java.util.List<java.lang.Integer> getSelectedIndeces()
```
  - next
```
public void next()
```
    Advance the index to the next image in the list. If the index is already at the last image, do nothing.
  - prev
```
public void prev()
```
    Step the index to the previous image in the list. If the index is already at the first image, do nothing.
  - first
```
public void first()
```
    Move the index to the first image in the list.
  - last
```
public void last()
```
    Move the image to the last image in the list.
  - skipBy
```
public void skipBy(int n)
```
    Skip forward or backward by the specified number of images. Positive numbers skip forward; negative skip backward. If skipping the requested number of frames would put the index out of range, the skip moves to the last or first image, as appropriate.
    
    Parameters:
    
    n - The number of images to skip.
  - size
```
public int size()
```
    return the number of images in the sequence.
    
    Returns:
    
    the number of images in the sequence.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.beans.PropertyChangeListener l)
```
    things we fire events for: PROP_BADGE_CHANGE and others
    
    Parameters:
    
    l -
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.beans.PropertyChangeListener l)
```
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
```
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
```
  - getTemplate
```
public java.lang.String getTemplate()
```
    return the template representing the sequence.
    
    Returns:
    
    the template
  - getStatus
```
public java.lang.String getStatus()
```
    get the current status
    
    Returns:
  - setStatus
```
protected void setStatus(java.lang.String status)
```
    set the current status, which is echoed back to the scientist.
    
    Parameters:
    
    status - the status
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent e)
```
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
  - findIndex
```
public int findIndex(java.lang.String name)
```
    returns the index of the name, or -1 if the name is not found. This is not the full filename, but instead just the part of the name within the walk. For example, For example if getTemplate is file:/tmp/$Y$m$d.gif, then the setSelectedName might be 20141111.gif.
    
    Parameters:
    
    name - the file name.
    
    Returns:
    
    the index, or -1 if the name is not found.
  - getSelectedName
```
public java.lang.String getSelectedName()
```
    return the name of the selected image. This is not the full filename, but instead just the part of the name within the walk. For example, For example if getTemplate is file:/tmp/$Y$m$d.gif, then the setSelectedName might be 20141111.gif.
    
    Returns:
    
    the name of the selected image.

Class WalkImageSequence

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_INDEX

PROP_SELECTED_INDECES

PROP_IMAGE_LOADED

PROP_THUMB_LOADED

PROP_USESUBRANGE

PROP_SEQUENCE_CHANGED

PROP_BADGE_CHANGE

PROP_TIMERANGE

status

PROP_STATUS

Constructor Detail

WalkImageSequence

Method Detail

getTimerange

setTimerange

initialLoad

indexOfSubrange

isLimitWarning

initQualitySequence

currentImage

getImage

imageAt

imageAtNoSubRange

getQCFolder

setQCFolder

getQualityControlSequence

isShowMissing

setShowMissing

isUseSubRange

setUseSubRange

setActiveSubrange

setActiveSubrange

setQCFilter

getActiveSubrange

getTimeSpan

getAllTimes

getIndex

setIndex

setSelectedIndeces

getSelectedIndeces

next

prev

first

last

skipBy

size

addPropertyChangeListener

removePropertyChangeListener

removePropertyChangeListener

addPropertyChangeListener

getTemplate

getStatus

setStatus

propertyChange

findIndex

getSelectedName