proto

Class FileMC

java.lang.Object

proto.FileMC

public class FileMC
extends Object

Write data structures in sequential order using Google's Prototype Buffer. The same class can be used to read data from ntuples. Each data record inside files is compressed on-fly using zip. A protocol Buffers file is provided which can be used for C++ input. Use the CBook package to create such files in C++.

Author:

S.Chekanov

Constructor Summary

Constructors

Constructor and Description
FileMC(String file) Open file for reading objects from a serialized file in sequential order.
FileMC(String file, String option) Open a file to write/read objects to/from a file in sequential order.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	close() Close the file
String	entriesToString() Get a string representing file content.
promc.io.ProMCDescriptionFile.ProMCDescription	fetchDescription() Get description information.
void	fetchDescriptionURL() Get the description from URL file.
String	getDescription()
long	getEvents()
promc.io.ProMCHeaderFile.ProMCHeader	getHeader() Get a header file information
boolean	getIsURL() Is this a remote file?
String	getLastModified() Last modified
String	getLogfileTxt() Return info about the log file.
long	getNEntries() Get number of events stored in the file.
String	getProMCDescriptionTxt() Return ProMCDescription.proto
String	getProMCHeaderTxt() Return ProMCHeader.proto
String	getProMCStatTxt() Return ProMCStat.proto
String	getProMCTxt() Return ProMC.proto.
long	getRequestedEvents()
promc.io.ProMCStatFile.ProMCStat	getStat() Get statistics information.
Map<String,Object>	getStoredProtoURL()
long	getVersion()
ZipFile	getZipFile() Return this zip file.
promc.io.ProMC.ProMCEvent	read() Read next event
promc.io.ProMC.ProMCEvent	read(long index) Get object from a file using its index.
promc.io.ProMC.ProMCEvent	read(String key) Read an event using a key
String	readLogfile() Return logfile text
void	readMeta() Read all metadata
long	size() Get the number of events stored in the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMC

public FileMC(String file,
      String option)

Open a file to write/read objects to/from a file in sequential order. If "w" option is set, the old file will be removed. Use close() to flash the buffer and close the file.

Parameters:

file - File name

option - Option to create the file. If "w" - write a file (or read) file, if "r" only read created file.

FileMC

public FileMC(String file)

Open file for reading objects from a serialized file in sequential order.

Parameters:

file - File name

Method Detail

getIsURL

public boolean getIsURL()

Is this a remote file?

Returns:

true if remote

fetchDescriptionURL

public void fetchDescriptionURL()

Get the description from URL file.

getStoredProtoURL

public Map<String,Object> getStoredProtoURL()

readMeta

public void readMeta()

Read all metadata

getLogfileTxt

public String getLogfileTxt()

Return info about the log file.

Returns:

log file name if it is stored.

readLogfile

public String readLogfile()

Return logfile text

Returns:

text of the log file

getLastModified

public String getLastModified()

Last modified

Returns:

getProMCDescriptionTxt

public String getProMCDescriptionTxt()

Return ProMCDescription.proto

Returns:

getProMCHeaderTxt

public String getProMCHeaderTxt()

Return ProMCHeader.proto

Returns:

getProMCTxt

public String getProMCTxt()

Return ProMC.proto.

Returns:

getProMCStatTxt

public String getProMCStatTxt()

Return ProMCStat.proto

Returns:

getVersion

public long getVersion()

getDescription

public String getDescription()

getEvents

public long getEvents()

getRequestedEvents

public long getRequestedEvents()

getZipFile

public ZipFile getZipFile()

Return this zip file.

Returns:

size

public long size()

Get the number of events stored in the file.

Returns:

number of stored objects

getNEntries

public long getNEntries()

Get number of events stored in the file. Same as size()

Returns:

number of stored objects

entriesToString

public String entriesToString()

Get a string representing file content.

Returns:

File content.

read

public promc.io.ProMC.ProMCEvent read()

Read next event

Returns:

next object.

getHeader

public promc.io.ProMCHeaderFile.ProMCHeader getHeader()

Get a header file information

Returns:

getStat

public promc.io.ProMCStatFile.ProMCStat getStat()

Get statistics information.

Returns:

fetchDescription

public promc.io.ProMCDescriptionFile.ProMCDescription fetchDescription()

Get description information.

Returns:

read

public promc.io.ProMC.ProMCEvent read(long index)

Get object from a file using its index.

Parameters:

index - of the object

Returns:

Object extracted object (or null)

read

public promc.io.ProMC.ProMCEvent read(String key)

Read an event using a key

Parameters:

key - key

Returns:

close

public boolean close()

Close the file

Returns: