org.gridfour.gvrs

Class GvrsInspector

java.lang.Object

org.gridfour.gvrs.GvrsInspector

public class GvrsInspector
extends Object

Provides a utility for inspecting a GVRS file to ensure that the data in the file is correctly structured and readable by applications. If checksums are enabled within the file, it also inspects the checksum values.

This class is not fully implemented at this time

Constructor Summary

Constructors

Constructor and Description
GvrsInspector(File file) Reads the GVRS file and checks for problematic elements including checksums (if enabled) that would indicate a corrupt file.

Method Summary

Modifier and Type	Method and Description
boolean	didFileFailInspection() Indicates whether the inspection detected a failure
boolean	didFileHeaderFailInspction() Indicates whether the inspection detected a failure in the header.
List<Integer>	getIndicesForFailedTiles() Gets a list of indices for tiles that failed inspection.
long	getPositionForInspectionTermination() Indicates the last position inspected within the file.
boolean	wasEntireFileInspected() Indicates whether the inspection was able to process the entire file.

Methods inherited from class java.lang.Object

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

Constructor Detail

GvrsInspector

public GvrsInspector(File file)
              throws IOException

Reads the GVRS file and checks for problematic elements including checksums (if enabled) that would indicate a corrupt file.

Parameters:

file - a valid file reference

Throws:

IOException - in the event of a unrecoverable I/O exception.

Method Detail

didFileFailInspection

public boolean didFileFailInspection()

Indicates whether the inspection detected a failure

Returns:

true if the inspection detected a failure; otherwise, false.

didFileHeaderFailInspction

public boolean didFileHeaderFailInspction()

Indicates whether the inspection detected a failure in the header.

Returns:

true if the inspection detected a failure in the header.

wasEntireFileInspected

public boolean wasEntireFileInspected()

Indicates whether the inspection was able to process the entire file. For certain kinds of failures, the inspector is not able to proceed beyond the error position. In such cases, this method will indicate that the entire file was not inspected.

Returns:

true if the entire file was inspected; otherwise, false.

getPositionForInspectionTermination

public long getPositionForInspectionTermination()

Indicates the last position inspected within the file. If the inspection cannot process the entire file due to an error condition, the the termination position will be recorded.

Returns:

a positive integer.

getIndicesForFailedTiles

public List<Integer> getIndicesForFailedTiles()

Gets a list of indices for tiles that failed inspection.

Returns:

a valid, potentially empty, list.