edu.uci.ics.ics163.gpsdrawupload

Class StrokeManager

java.lang.Object

edu.uci.ics.ics163.gpsdrawupload.StrokeManager

public class StrokeManager
extends java.lang.Object

This is the primary class used in this package. The StrokeManager holds strokes and points and manages uploading them when necessary. If the upload fails for any reason, the StrokeManager holds the points and alerts the callback function if necessary. Future uploads will attempt to upload the points again.

Author:

djp3

Constructor Summary

Constructors

Constructor and Description
StrokeManager() The constructor for this class if no callback is desired
StrokeManager(UploadCallback callback) The constructor for this class if callbacks post-upload are desired.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPoint(java.lang.String strokeName, Point point) Add a point to a stroke.
void	addPoints(java.lang.String strokeName, java.util.Set<Point> points) Add a set of points to a stroke.
int	countPoints() Convenience function if you want to know how many points are currently in the StrokeManager across all strokes.
int	countStrokes() Convenience function if you want to know how many strokes are currently in the StrokeManager.
void	onFailure(java.lang.String strokeId, java.util.Set<Point> points)
void	onSuccess(java.lang.String strokeId, java.util.Set<Point> points)
void	removePoint(java.lang.String strokeName, Point point) Remove a point from a stroke.
void	removePoints(java.lang.String strokeName, java.util.Set<Point> points) Remove points from a stroke.
void	setStrokeColor(java.lang.String strokeName, int r, int g, int b) Set the color for a stroke.
void	upload(java.lang.String group_name, java.lang.String drawing_name) This uploads the strokes and points that the StrokeManager knows about to the server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StrokeManager

public StrokeManager()

The constructor for this class if no callback is desired

StrokeManager

public StrokeManager(UploadCallback callback)

The constructor for this class if callbacks post-upload are desired.

Method Detail

setStrokeColor

public void setStrokeColor(java.lang.String strokeName,
                  int r,
                  int g,
                  int b)

Set the color for a stroke. If the stroke has previously been assigned a color then the color is overwritten. Strokes without colors default to black.

Parameters:

strokeName -

r -

g -

b -

addPoint

public void addPoint(java.lang.String strokeName,
            Point point)

Add a point to a stroke. If the strokeName exists, the point is appended to the existing stroke

Parameters:

strokeName -

point -

addPoints

public void addPoints(java.lang.String strokeName,
             java.util.Set<Point> points)

Add a set of points to a stroke. If the strokeName exists, the points are appended to the existing stroke.

Parameters:

strokeName -

points -

removePoint

public void removePoint(java.lang.String strokeName,
               Point point)

Remove a point from a stroke. If the stroke doesn't exist, this fails silently. If the point doesn't exist this fails silently. If the point is the final one in a stroke, the stroke is removed.

Parameters:

strokeName -

point -

removePoints

public void removePoints(java.lang.String strokeName,
                java.util.Set<Point> points)

Remove points from a stroke. If the stroke doesn't exist, this fails silently. If the points don't exist this fails silently for those that don't exist. If the points are the final ones in a stroke, the stroke is removed.

Parameters:

strokeName -

points -

upload

public void upload(java.lang.String group_name,
          java.lang.String drawing_name)

This uploads the strokes and points that the StrokeManager knows about to the server. This is done in batches of MAX_CHUNK_SIZE. For each batch of MAX_CHUNK_SIZE, a callback is executed (provided that a callback function was given in the constructor). After uploading, the points are removed from the StrokeManager. If any portion of the upload fails, the points are kept by the StrokeManager. Subsequent calls to upload will attempt to upload them again. Upload attempts are asynchronous, so this function will return before all network traffic is completed.

Parameters:

group_name -

drawing_name -

r -

g -

b -

countStrokes

public int countStrokes()

Convenience function if you want to know how many strokes are currently in the StrokeManager. This goes to zero during an upload and may increase again if the upload subsequently fails.

Returns:

countPoints

public int countPoints()

Convenience function if you want to know how many points are currently in the StrokeManager across all strokes. This goes to zero during an upload and may increase again if the upload subsequently fails.

Returns:

onSuccess

public void onSuccess(java.lang.String strokeId,
             java.util.Set<Point> points)

onFailure

public void onFailure(java.lang.String strokeId,
             java.util.Set<Point> points)