Package com.j3d.storage.files.protocol.proj

Class PF3

java.lang.Object

com.j3d.storage.files.protocol.GenericFileProtocol

com.j3d.storage.files.protocol.proj.ProjectFile

com.j3d.storage.files.protocol.proj.PF3

All Implemented Interfaces:

FileProtocol

public class PF3
extends ProjectFile

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PF3.SuperMap<T extends GObject>	A utility class that extends Pair to store two maps related to some GObject.

Nested classes/interfaces inherited from class com.j3d.storage.files.protocol.proj.ProjectFile

ProjectFile.PF

Constructor Summary

Constructors

Constructor	Description
PF3()

Method Summary

Modifier and Type	Method	Description
static void	beforeElement(DataOutputStream dos)	Writes a special delimiter to indicate the start of an element within a list in the data stream.
static void	beginList(DataOutputStream dos)	Writes a special delimiter to indicate the beginning of a list in the data stream.
static void	consumeBeforeElement(DataInputStream dis, String errStr, int index)	Consumes and validates the element delimiter from the data stream.
static void	consumeBeginList(DataInputStream dis, String errStr)	Consumes and validates the beginning of a list delimiter from the data stream.
static void	consumeEndList(DataInputStream dis, String errStr)	Consumes and validates the end of a list delimiter from the data stream.
static void	endList(DataOutputStream dos)	Writes a special delimiter to indicate the end of a list in the data stream.
private static void	ifAnyNull(String errStr, String id, String label, int code, SceneObject... objs)	Checks if any of the provided SceneObjects are null.
private static void	msg(String message)	Logs a message to the application's log output.
private static PF3.SuperMap<GCurve>	readCurves(DataInputStream dis, PF3.SuperMap<GPoint> pointSuperMap, Spinner sp)	Reads a list of GCurve objects from the provided DataInputStream.
<T extends ArrayList> T	readFile(String path, String name, Spinner throbber)	Reads a file from the specified path and returns its content as an object of type T.
private static HashMap<String,Layer>	readLayers(DataInputStream dis, Spinner sp)	Reads a list of Layer objects from the provided DataInputStream.
private static PF3.SuperMap<GLine>	readLines(DataInputStream dis, PF3.SuperMap<GPoint> pointSuperMap, Spinner sp)	Reads a list of GLine objects from the provided DataInputStream.
private static PF3.SuperMap<GPoint>	readPoints(DataInputStream dis, Spinner sp)	Reads a list of GPoint objects from the provided DataInputStream.
static void	readSixNine(DataInputStream dis)	Reads and validates a magic number (69) from the data stream for file integrity check.
private static HashMap<String,Thing>	readThings(DataInputStream dis, HashMap<String,Layer> layers, Spinner sp)	Reads a list of Thing objects from the provided DataInputStream.
private static PF3.SuperMap<GTri>	readTris(DataInputStream dis, PF3.SuperMap<GLine> lines, PF3.SuperMap<GPoint> points, Spinner sp)	Reads a list of GTri objects from the provided DataInputStream.
private static void	writeCurves(DataOutputStream dos, ArrayList<Pair<UUID,GCurve>> curves)	Writes a list of GCurve objects to the provided DataOutputStream.
<T extends ArrayList> void	writeFile(String path, String name, T data)	Writes the provided data to a file at the specified path.
private void	writeLayers(DataOutputStream dos, LayerList layers)	Writes a list of Layer objects to the provided DataOutputStream.
private static void	writeLines(DataOutputStream dos, ArrayList<Pair<UUID,GLine>> lines)	Writes a list of GLine objects to the provided DataOutputStream.
private static void	writePoints(DataOutputStream dos, ArrayList<Pair<UUID,GPoint>> points)	Writes a list of GPoint objects to the provided DataOutputStream.
static void	writeSixNine(DataOutputStream dos)	Writes a magic number (69) to the data stream for file integrity check.
private static void	writeThings(DataOutputStream dos, ArrayList<Pair<String,Thing>> things)	Writes a list of Thing objects to the provided DataOutputStream.
private static void	writeTris(DataOutputStream dos, ArrayList<Pair<UUID,GTri>> tris)	Writes a list of GTri objects to the provided DataOutputStream.

Methods inherited from class com.j3d.storage.files.protocol.proj.ProjectFile

colToInt, convertibleFromLower, convertibleToHigher, getExtension, getFromVersion, getHeaderReader, getHeaderWriter, getProtocolHeader, getProtocolVersion, handleErr, intToCol

Methods inherited from class com.j3d.storage.files.protocol.GenericFileProtocol

readHeader, writeHeader

Methods inherited from class java.lang.Object

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

Constructor Details

PF3

public PF3()

Method Details

writeFile

public <T extends ArrayList> void writeFile(String path,
 String name,
 T data)

Description copied from interface: FileProtocol

Writes the provided data to a file at the specified path. This should be a direct inverse of the corresponding FileProtocol.readFile(String, String, Spinner) method.

Specified by:

writeFile in interface FileProtocol

Overrides:

writeFile in class ProjectFile

Type Parameters:

T - The type of the data to be written, which must extend ArrayList.

Parameters:

path - The path to the file to be written.

data - The data to be written to the file.

readFile

public <T extends ArrayList> T readFile(String path,
 String name,
 Spinner throbber)
                                 throws Exception

Description copied from interface: FileProtocol

Reads a file from the specified path and returns its content as an object of type T. This should be a direct inverse of the corresponding FileProtocol.writeFile(String, String, ArrayList) method.

Specified by:

readFile in interface FileProtocol

Overrides:

readFile in class ProjectFile

Type Parameters:

T - The type of the object to be returned.

Parameters:

path - The path to the file to be read.

name - The name of the file to be read.

throbber - The Spinner instance

Returns:

The content of the file as an object of type T.

Throws:

Exception

writeLayers

private void writeLayers(DataOutputStream dos,
 LayerList layers)
                  throws IOException

Writes a list of Layer objects to the provided DataOutputStream.

Parameters:

dos - The DataOutputStream to write to.

layers - The LayerList containing the layers to write.

Throws:

IOException - If an I/O error occurs.

readLayers

private static HashMap<String,Layer> readLayers(DataInputStream dis,
 Spinner sp)
                                         throws IOException

Reads a list of Layer objects from the provided DataInputStream.

Parameters:

dis - The DataInputStream to read from.

sp - The Spinner to update progress.

Returns:

A HashMap where keys are layer names and values are Layer objects.

Throws:

IOException - If an I/O error occurs or the file is corrupted.

writeThings

private static void writeThings(DataOutputStream dos,
 ArrayList<Pair<String,Thing>> things)
                         throws IOException

Writes a list of Thing objects to the provided DataOutputStream.

Parameters:

dos - The DataOutputStream to write to.

things - An ArrayList of Pairs, where each pair contains the parent UUID (as String) and the Thing to write.

Throws:

IOException - If an I/O error occurs.

readThings

private static HashMap<String,Thing> readThings(DataInputStream dis,
 HashMap<String,Layer> layers,
 Spinner sp)
                                         throws IOException

Reads a list of Thing objects from the provided DataInputStream.

Parameters:

dis - The DataInputStream to read from.

layers - A HashMap of existing Layers, used to assign parent layers to things.

sp - The Spinner to update progress.

Returns:

A HashMap where keys are thing IDs (as String) and values are Thing objects.

Throws:

IOException - If an I/O error occurs, the file is corrupted, or a parent layer is not found.

writeCurves

private static void writeCurves(DataOutputStream dos,
 ArrayList<Pair<UUID,GCurve>> curves)
                         throws IOException

Writes a list of GCurve objects to the provided DataOutputStream.

Parameters:

dos - The DataOutputStream to write to.

curves - An ArrayList of Pairs, where each pair contains the parent UUID and the GCurve to write.

Throws:

IOException - If an I/O error occurs.

readCurves

private static PF3.SuperMap<GCurve> readCurves(DataInputStream dis,
 PF3.SuperMap<GPoint> pointSuperMap,
 Spinner sp)
                                        throws IOException

Reads a list of GCurve objects from the provided DataInputStream.

Parameters:

dis - The DataInputStream to read from.

pointSuperMap - A PF3.SuperMap containing GPoint objects, used to resolve curve points.

sp - The Spinner to update progress.

Returns:

A PF3.SuperMap containing the read GCurve objects, mapped by their ID and parent thing ID.

Throws:

IOException - If an I/O error occurs or the file is corrupted.

writeTris

private static void writeTris(DataOutputStream dos,
 ArrayList<Pair<UUID,GTri>> tris)
                       throws IOException

Writes a list of GTri objects to the provided DataOutputStream.

Parameters:

dos - The DataOutputStream to write to.

tris - An ArrayList of Pairs, where each pair contains the parent UUID and the GTri to write.

Throws:

IOException - If an I/O error occurs.

readTris

private static PF3.SuperMap<GTri> readTris(DataInputStream dis,
 PF3.SuperMap<GLine> lines,
 PF3.SuperMap<GPoint> points,
 Spinner sp)
                                    throws IOException

Reads a list of GTri objects from the provided DataInputStream.

Parameters:

dis - The DataInputStream to read from.

lines - A PF3.SuperMap containing GLine objects, used to resolve triangle legs.

points - A PF3.SuperMap containing GPoint objects, used to resolve triangle winding points.

sp - The Spinner to update progress.

Returns:

A PF3.SuperMap containing the read GTri objects, mapped by their ID and parent thing ID.

Throws:

IOException - If an I/O error occurs or the file is corrupted.

writeLines

private static void writeLines(DataOutputStream dos,
 ArrayList<Pair<UUID,GLine>> lines)
                        throws IOException

Writes a list of GLine objects to the provided DataOutputStream.

Parameters:

dos - The DataOutputStream to write to.

lines - An ArrayList of Pairs, where each pair contains the parent UUID and the GLine to write.

Throws:

IOException - If an I/O error occurs.

readLines

private static PF3.SuperMap<GLine> readLines(DataInputStream dis,
 PF3.SuperMap<GPoint> pointSuperMap,
 Spinner sp)
                                      throws IOException

Reads a list of GLine objects from the provided DataInputStream.

Parameters:

dis - The DataInputStream to read from.

pointSuperMap - A PF3.SuperMap containing GPoint objects, used to resolve line endpoints.

sp - The Spinner to update progress.

Returns:

A PF3.SuperMap containing the read GLine objects, mapped by their ID and parent thing ID.

Throws:

IOException - If an I/O error occurs or the file is corrupted.

writePoints

private static void writePoints(DataOutputStream dos,
 ArrayList<Pair<UUID,GPoint>> points)
                         throws IOException

Writes a list of GPoint objects to the provided DataOutputStream.

Parameters:

dos - The DataOutputStream to write to.

points - An ArrayList of Pairs, where each pair contains the parent UUID and the GPoint to write.

Throws:

IOException - If an I/O error occurs.

readPoints

private static PF3.SuperMap<GPoint> readPoints(DataInputStream dis,
 Spinner sp)
                                        throws IOException

Reads a list of GPoint objects from the provided DataInputStream.

Parameters:

dis - The DataInputStream to read from.

sp - The Spinner to update progress.

Returns:

A PF3.SuperMap containing the read GPoint objects, mapped by their ID and parent thing ID.

Throws:

IOException - If an I/O error occurs or the file is corrupted.

beginList

public static void beginList(DataOutputStream dos)
                      throws IOException

Writes a special delimiter to indicate the beginning of a list in the data stream.

Parameters:

dos - The DataOutputStream to write to.

Throws:

IOException - If an I/O error occurs.

consumeBeginList

public static void consumeBeginList(DataInputStream dis,
 String errStr)
                             throws IOException

Consumes and validates the beginning of a list delimiter from the data stream.

Parameters:

dis - The DataInputStream to read from.

Throws:

IOException - If an I/O error occurs or the expected delimiter is not found.

endList

public static void endList(DataOutputStream dos)
                    throws IOException

Writes a special delimiter to indicate the end of a list in the data stream.

Parameters:

dos - The DataOutputStream to write to.

Throws:

IOException - If an I/O error occurs.

consumeEndList

public static void consumeEndList(DataInputStream dis,
 String errStr)
                           throws IOException

Consumes and validates the end of a list delimiter from the data stream.

Parameters:

dis - The DataInputStream to read from.

Throws:

IOException - If an I/O error occurs or the expected delimiter is not found.

beforeElement

public static void beforeElement(DataOutputStream dos)
                          throws IOException

Writes a special delimiter to indicate the start of an element within a list in the data stream.

Parameters:

dos - The DataOutputStream to write to.

Throws:

IOException - If an I/O error occurs.

consumeBeforeElement

public static void consumeBeforeElement(DataInputStream dis,
 String errStr,
 int index)
                                 throws IOException

Consumes and validates the element delimiter from the data stream.

Parameters:

dis - The DataInputStream to read from.

Throws:

IOException - If an I/O error occurs or the expected delimiter is not found.

writeSixNine

public static void writeSixNine(DataOutputStream dos)
                         throws IOException

Writes a magic number (69) to the data stream for file integrity check.

Parameters:

dos - The DataOutputStream to write to.

Throws:

IOException - If an I/O error occurs.

readSixNine

public static void readSixNine(DataInputStream dis)
                        throws IOException

Reads and validates a magic number (69) from the data stream for file integrity check.

Parameters:

dis - The DataInputStream to read from.

Throws:

IOException - If an I/O error occurs or the expected magic number is not found.

msg

private static void msg(String message)

Logs a message to the application's log output.

Parameters:

message - The message string to be logged.

ifAnyNull

private static void ifAnyNull(String errStr,
 String id,
 String label,
 int code,
 SceneObject... objs)

Checks if any of the provided SceneObjects are null. If a null object is found, it handles a ProjectFileException indicating a corrupted file. This is typically used during file reading to ensure all referenced objects exist.

Parameters:

errStr - A string describing the type of object being checked (e.g., "tri", "curve").

id - The ID of the main object that references the potentially null objects.

label - A string describing the type of referenced object (e.g., "point", "line").

code - The error code to associate with the ProjectFileException.

objs - A variable argument list of SceneObjects to check for null.