votorola.a.count

Class ReadyDirectory

java.lang.Object

java.io.File

OutputStore.ReadyDirectory

ReadyDirectory

All Implemented Interfaces:

Serializable, Comparable<File>

@ThreadSafe
public final class ReadyDirectory
extends OutputStore.ReadyDirectory

The path to a snap/readyCount record. It is the file part of the backing for a poll count. It is guaranteed to be in canonical form at the time of construction.

See Also:

snap/readyCount record, Count, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FileFilter	READY_DIRECTORY_FILTER A file filter that accepts only apparent ready directories.

Fields inherited from class OutputStore.ReadyDirectory

STATUS_FLAG_MOUNTED, STATUS_FLAG_REPORTED, STATUS_FLAGS_COUNT

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor and Description
ReadyDirectory(File _d) Constructs a ReadyDirectory from an abstract (File) pathname.
ReadyDirectory(String pathname) Constructs a ReadyDirectory from a string pathname.

Method Summary

Methods

Modifier and Type	Method and Description
static ReadyDirectory	createReadyDirectory(File d, String readyTracePathname, PipeRecognizer pipeRecognizer) Creates a new ReadyDirectory.
boolean	isInitWarned() Answers whether any warnings were logged during the construction of this ready directory.
boolean	isMounted() Answers whether the count is nominally mounted.
int	mount(VoteServer.Run run, NetworkTrace networkTrace, boolean isVerbose) Tallies the results and posts them to the database and filebase.
File	mountedDirectory() The directory to which the count is serialized when mounted.
File	newSerialFile(String serviceName) Constructs the formal file to which the count for the specified poll service is serialized when mounted.
PipeRecognizer	pipeRecognizer() The pipe recognizer for this ready directory.
File	pollspace0Cache() File to which JSON content for the first block of a PollspaceWAP response is written, when the count is mounted.
File	pollspace0PCache() File to which JSON content for the first block of a PollspaceWAP response is written in prettified form, when the count is mounted.
File	readyTraceLink() The symbolic link to the ready directory of the trust network trace.
boolean	unmount(VoteServer.Run run) Reverses a previous mount, erasing the results from the database and filebase.

Methods inherited from class OutputStore.ReadyDirectory

snapDirectory, statusPrintln, statusPrintln, toUIString, toUIString

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

READY_DIRECTORY_FILTER

public static final FileFilter READY_DIRECTORY_FILTER

A file filter that accepts only apparent ready directories.

Constructor Detail

ReadyDirectory

public ReadyDirectory(File _d)
               throws IOException

Constructs a ReadyDirectory from an abstract (File) pathname.

Parameters:

_d - the abstract pathname. It will be converted to canonical form if necessary.

Throws:

FileNotFoundException - if no directory exists at the specified pathname.

IOException

See Also:

createReadyDirectory(File,String,PipeRecognizer)

ReadyDirectory

public ReadyDirectory(String pathname)
               throws IOException

Constructs a ReadyDirectory from a string pathname.

Parameters:

pathname - the string pathname, per File(pathname). It will be converted to canonical form if necessary.

Throws:

FileNotFoundException - if no directory exists at the specified pathname.

IOException

See Also:

createReadyDirectory(File,String,PipeRecognizer)

Method Detail

createReadyDirectory

public static ReadyDirectory createReadyDirectory(File d,
                                  String readyTracePathname,
                                  PipeRecognizer pipeRecognizer)
                                           throws IOException

Creates a new ReadyDirectory.

Parameters:

d - the abstract pathname. It will be converted to canonical form if necessary.

readyTracePathname - the pathname of the ready directory of the trust trace to use.

Throws:

IOException

See Also:

pipeRecognizer()

isInitWarned

public boolean isInitWarned()

Answers whether any warnings were logged during the construction of this ready directory.

mount

public int mount(VoteServer.Run run,
        NetworkTrace networkTrace,
        boolean isVerbose)
          throws VotorolaException

Tallies the results and posts them to the database and filebase.

Parameters:

networkTrace - the previously mounted trace of the trust network.

isVerbose - if true, additional details are printed to standard output as the mount progresses.

Returns:

count of polls tallied.

Throws:

VotorolaException

See Also:

isMounted(), unmount(VoteServer.Run)

mountedDirectory

public File mountedDirectory()

The directory to which the count is serialized when mounted.

newSerialFile

public File newSerialFile(String serviceName)

Constructs the formal file to which the count for the specified poll service is serialized when mounted.

pipeRecognizer

public PipeRecognizer pipeRecognizer()

The pipe recognizer for this ready directory.

pollspace0Cache

public File pollspace0Cache()

File to which JSON content for the first block of a PollspaceWAP response is written, when the count is mounted.

pollspace0PCache

public File pollspace0PCache()

File to which JSON content for the first block of a PollspaceWAP response is written in prettified form, when the count is mounted.

readyTraceLink

public File readyTraceLink()

The symbolic link to the ready directory of the trust network trace.

unmount

public boolean unmount(VoteServer.Run run)
                throws IOException,
                       SQLException

Reverses a previous mount, erasing the results from the database and filebase.

Returns:

true if the count was unmounted, false if it was not mounted to begin with, either in whole or part.

Throws:

IOException

SQLException

See Also:

isMounted(), mount(VoteServer.Run,NetworkTrace,boolean)

isMounted

public boolean isMounted()

Answers whether the count is nominally mounted.

Specified by:

isMounted in class OutputStore.ReadyDirectory