org.jmol.io

Class JmolUtil

java.lang.Object

org.jmol.io.JmolUtil

All Implemented Interfaces:

JmolZipUtilities

public class JmolUtil
extends java.lang.Object
implements JmolZipUtilities

Constructor Summary

Constructors

Constructor and Description
JmolUtil()

Method Summary

Modifier and Type	Method and Description
private static javajs.util.SB	checkSpecialData(javajs.api.GenericZipTools zpt, java.io.InputStream is, java.lang.String[] zipDirectory) called by SmarterJmolAdapter to see if we have a Spartan directory and, if so, open it and get all the data into the correct order.
(package private) static java.lang.String[]	checkSpecialInZip(java.lang.String[] zipDirectory) called by SmarterJmolAdapter to see if we can automatically assign a file from the zip file.
boolean	clearAndCachePngjFile(JmolBinary jmb, java.lang.String[] data)
java.lang.Object	getAtomSetCollectionOrBufferedReaderFromZip(Viewer vwr, JmolAdapter adapter, java.io.InputStream is, java.lang.String fileName, java.lang.String[] zipDirectory, java.util.Map<java.lang.String,java.lang.Object> htParams, int subFilePtr, boolean asBufferedReader)
byte[]	getCachedPngjBytes(JmolBinary jmb, java.lang.String pathName)
java.lang.Object	getImage(Viewer vwr, java.lang.Object fullPathNameOrBytes, java.lang.String echoName, boolean forceSync)
private static java.lang.String[]	getSpartanDirs(java.lang.String outputFileData) read the output file from the Spartan directory and decide from that what files need to be read and in what order - usually M0001 or a set of Profiles.
private static java.lang.String[]	getSpartanFileList(java.lang.String name, java.lang.String[] dirNums) returns the list of files to read for every Spartan spardir.
private static java.lang.String	shortSceneFilename(java.lang.String pathName)
java.lang.String[]	spartanFileList(javajs.api.GenericZipTools zpt, java.lang.String name, java.lang.String type) Special loading for file directories.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmolUtil

public JmolUtil()

Method Detail

checkSpecialData

private static javajs.util.SB checkSpecialData(javajs.api.GenericZipTools zpt,
                                               java.io.InputStream is,
                                               java.lang.String[] zipDirectory)

called by SmarterJmolAdapter to see if we have a Spartan directory and, if so, open it and get all the data into the correct order.

Parameters:

zpt -

is -

zipDirectory -

Returns:

String data for processing

checkSpecialInZip

static java.lang.String[] checkSpecialInZip(java.lang.String[] zipDirectory)

called by SmarterJmolAdapter to see if we can automatically assign a file from the zip file. If so, return a subfile list for this file. The first element of the list is left empty -- it would be the zipfile name. Assignment can be made if (1) there is only one file in the collection or (2) if the first file is xxxx.spardir/ Note that __MACOS? files are ignored by the ZIP file reader.

Parameters:

zipDirectory -

Returns:

subFileList

getSpartanDirs

private static java.lang.String[] getSpartanDirs(java.lang.String outputFileData)

read the output file from the Spartan directory and decide from that what files need to be read and in what order - usually M0001 or a set of Profiles. But Spartan saves the Profiles in alphabetical order, not numerical. So we fix that here.

Parameters:

outputFileData -

Returns:

String[] list of files to read

getSpartanFileList

private static java.lang.String[] getSpartanFileList(java.lang.String name,
                                                     java.lang.String[] dirNums)

returns the list of files to read for every Spartan spardir. Simple numbers are assumed to be Profiles; others are models.

Parameters:

name -

dirNums -

Returns:

String[] list of files to read given a list of directory names

shortSceneFilename

private static java.lang.String shortSceneFilename(java.lang.String pathName)

getAtomSetCollectionOrBufferedReaderFromZip

public java.lang.Object getAtomSetCollectionOrBufferedReaderFromZip(Viewer vwr,
                                                                    JmolAdapter adapter,
                                                                    java.io.InputStream is,
                                                                    java.lang.String fileName,
                                                                    java.lang.String[] zipDirectory,
                                                                    java.util.Map<java.lang.String,java.lang.Object> htParams,
                                                                    int subFilePtr,
                                                                    boolean asBufferedReader)

Specified by:

getAtomSetCollectionOrBufferedReaderFromZip in interface JmolZipUtilities

clearAndCachePngjFile

public boolean clearAndCachePngjFile(JmolBinary jmb,
                                     java.lang.String[] data)

getCachedPngjBytes

public byte[] getCachedPngjBytes(JmolBinary jmb,
                                 java.lang.String pathName)

Specified by:

getCachedPngjBytes in interface JmolZipUtilities

spartanFileList

public java.lang.String[] spartanFileList(javajs.api.GenericZipTools zpt,
                                          java.lang.String name,
                                          java.lang.String type)

Special loading for file directories. This method is called from the FileManager via SmarterJmolAdapter. It's here because Resolver is the place where all distinctions are made. In the case of spt files, no need to load them; here we are just checking for type. In the case of .spardir directories, we need to provide a list of the critical files that need loading and concatenation for the SpartanSmolReader. we return an array for which: [0] file type (class prefix) or null for SPT file [1] header to add for each BEGIN/END block (ignored) [2...] files to load and concatenate

Specified by:

spartanFileList in interface JmolZipUtilities

Parameters:

name -

type -

Returns:

array detailing action for this set of files

getImage

public java.lang.Object getImage(Viewer vwr,
                                 java.lang.Object fullPathNameOrBytes,
                                 java.lang.String echoName,
                                 boolean forceSync)

Specified by:

getImage in interface JmolZipUtilities