org.lcsim.lcio

Class LCIOWriter

java.lang.Object

org.lcsim.lcio.LCIOWriter

public class LCIOWriter
extends Object

A class for writing out LCIO files. The LCIO writer maintains a list of collections to ignore, and also a list of collections to write out. If the list of collections to write out is not empty then all collections are written out except those in the ignore list. If the list of collections to write out is not empty, then only the specified collections are written out (and the ignore list is ignored).

Collections for which the LCIOConstants.BITTransient bit is set in the meta-data are never written out.

Author:

Tony Johnson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	LCIOWriter.DefaultRunHeader

Field Summary

Fields

Modifier and Type	Field and Description
private File	file
private Set<String>	ignore
private String	lastDetectorName
private int	lastRunNumber
private static Logger	log
private HandlerManager	manager
private Set<String>	only
private hep.io.sio.SIOWriter	writer

Constructor Summary

Constructors

Constructor and Description
LCIOWriter(File file) Create a writer for writing LCIO files
LCIOWriter(File file, Collection<String> ignoreCollections) Create a writer for writing LCIO files
LCIOWriter(String file) Create a writer for writing LCIO files
LCIOWriter(String file, Collection<String> ignoreCollections) Create a writer for writing LCIO files

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllIgnore(Collection<String> collections)
void	addAllWriteOnly(Collection<String> collections)
void	addIgnore(String collection) Add an entry to the list of collections to ignore (not write out)
void	addWriteOnly(String collection) Add an entry to the list of collections to write out
void	clearIgnore() Clear the list of ignored collections.
void	clearWriteOnly() Clear the list of collections to be written out
void	close()
void	flush()
private boolean	isValidCollectionName(String name)
void	removeIgnore(String collection) Remove an entry to the list of collections to ignore (not write out)
void	removeWriteOnly(String collection) Remove an entry to the list of collections to write out
void	reOpen()
void	write(EventHeader event)
void	write(LCIORunHeader header)
private void	writeData(EventHeader event, boolean headerOnly)
private void	writeData(LCIORunHeader header)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final Logger log

writer

private hep.io.sio.SIOWriter writer

manager

private final HandlerManager manager

lastRunNumber

private int lastRunNumber

lastDetectorName

private String lastDetectorName

ignore

private Set<String> ignore

only

private Set<String> only

file

private File file

Constructor Detail

LCIOWriter

public LCIOWriter(File file)
           throws IOException

Create a writer for writing LCIO files

Parameters:

file - The file to write

Throws:

IOException

LCIOWriter

public LCIOWriter(String file)
           throws IOException

Create a writer for writing LCIO files

Parameters:

file - The name of the file to write

Throws:

IOException

LCIOWriter

public LCIOWriter(File file,
          Collection<String> ignoreCollections)
           throws IOException

Create a writer for writing LCIO files

Parameters:

file - The file to write

ignoreCollections - The collections that should not be written out.

Throws:

IOException

LCIOWriter

public LCIOWriter(String file,
          Collection<String> ignoreCollections)
           throws IOException

Create a writer for writing LCIO files

Parameters:

file - The name of the file to write

ignoreCollections - The collections that should not be written out.

Throws:

IOException

Method Detail

addIgnore

public void addIgnore(String collection)

Add an entry to the list of collections to ignore (not write out)

Parameters:

collection - The collection to tadd

addAllIgnore

public void addAllIgnore(Collection<String> collections)

removeIgnore

public void removeIgnore(String collection)

Remove an entry to the list of collections to ignore (not write out)

Parameters:

collection - The collection to remove

clearIgnore

public void clearIgnore()

Clear the list of ignored collections.

addWriteOnly

public void addWriteOnly(String collection)

Add an entry to the list of collections to write out

Parameters:

collection - The collection to tadd

addAllWriteOnly

public void addAllWriteOnly(Collection<String> collections)

removeWriteOnly

public void removeWriteOnly(String collection)

Remove an entry to the list of collections to write out

Parameters:

collection - The collection to remove

clearWriteOnly

public void clearWriteOnly()

Clear the list of collections to be written out

close

public void close()
           throws IOException

Throws:

IOException

flush

public void flush()
           throws IOException

Throws:

IOException

reOpen

public void reOpen()
            throws IOException

Throws:

IOException

writeData

private void writeData(EventHeader event,
             boolean headerOnly)
                throws IOException

Throws:

IOException

writeData

private void writeData(LCIORunHeader header)
                throws IOException

Throws:

IOException

write

public void write(EventHeader event)
           throws IOException

Throws:

IOException

write

public void write(LCIORunHeader header)
           throws IOException

Throws:

IOException

isValidCollectionName

private boolean isValidCollectionName(String name)