de.mpg.biochem.mars.molecule

Class AbstractJsonConvertibleRecord

java.lang.Object

de.mpg.biochem.mars.molecule.AbstractJsonConvertibleRecord

All Implemented Interfaces:

JsonConvertibleRecord

Direct Known Subclasses:

AbstractMarsRecord, AbstractMoleculeArchive, AbstractMoleculeArchiveIndex, AbstractMoleculeArchiveProperties, DefaultJsonConverter, MarsBdvSource, MarsDocument, MarsOMEChannel, MarsOMEImage, MarsOMEPlane, MarsPosition, MarsRegion, Peak, PeakShape

public abstract class AbstractJsonConvertibleRecord
extends java.lang.Object
implements JsonConvertibleRecord

Abstract superclass for JsonConvertibleRecords. Contains basic conversion methods to and from Json based on the Jackson streaming API. This abstract class can be extended for any classes that needs to be serialized or de-serialized from Json. The subclass must implement the createIOMaps method to define the input and output Predicate maps that determine how objects, fields, arrays should be stored using the Jackson streaming API.

For examples, see MarsRecord, AbstractMolecule, AbstractMarsMetadata.

Constructor Summary

Constructors

Constructor and Description
AbstractJsonConvertibleRecord() Constructor for creating a JsonConvertibleRecord.

Method Summary

Modifier and Type	Method and Description
protected abstract void	createIOMaps() Must be implemented in subclasses to define how fields, objects, arrays should be saved based on the Jackson streaming API.
java.lang.String	dumpJSON() Get the record in Json string format.
void	fromJSON(com.fasterxml.jackson.core.JsonParser jParser) Read a record from JSON.
java.util.function.Predicate<com.fasterxml.jackson.core.JsonGenerator>	getJsonGenerator(java.lang.String field) Get the JsonGenerator for a field.
java.util.function.Predicate<com.fasterxml.jackson.core.JsonParser>	getJsonParser(java.lang.String field) Get the JsonParser for a field.
void	setJsonField(java.lang.String field, MarsUtil.ThrowingConsumer<com.fasterxml.jackson.core.JsonGenerator,java.io.IOException> output, MarsUtil.ThrowingConsumer<com.fasterxml.jackson.core.JsonParser,java.io.IOException> input)
void	setShowWarnings(boolean showWarnings)
void	toJSON(com.fasterxml.jackson.core.JsonGenerator jGenerator) Stream a record to JSON.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJsonConvertibleRecord

public AbstractJsonConvertibleRecord()

Constructor for creating a JsonConvertibleRecord.

Method Detail

toJSON

public void toJSON(com.fasterxml.jackson.core.JsonGenerator jGenerator)
            throws java.io.IOException

Stream a record to JSON. Stream a record from to a file using the JsonGenerator stream provided.

Specified by:

toJSON in interface JsonConvertibleRecord

Parameters:

jGenerator - A JsonGenerator for streaming a record to a file.

Throws:

java.io.IOException - if there is a problem reading from the file.

fromJSON

public void fromJSON(com.fasterxml.jackson.core.JsonParser jParser)
              throws java.io.IOException

Read a record from JSON. Load a record from a file using the JsonParser stream provided.

Specified by:

fromJSON in interface JsonConvertibleRecord

Parameters:

jParser - A JsonParser for loading the record from a file.

Throws:

java.io.IOException - if there is a problem reading from the file.

setShowWarnings

public void setShowWarnings(boolean showWarnings)

Specified by:

setShowWarnings in interface JsonConvertibleRecord

setJsonField

public void setJsonField(java.lang.String field,
                         MarsUtil.ThrowingConsumer<com.fasterxml.jackson.core.JsonGenerator,java.io.IOException> output,
                         MarsUtil.ThrowingConsumer<com.fasterxml.jackson.core.JsonParser,java.io.IOException> input)

Specified by:

setJsonField in interface JsonConvertibleRecord

getJsonGenerator

public java.util.function.Predicate<com.fasterxml.jackson.core.JsonGenerator> getJsonGenerator(java.lang.String field)

Get the JsonGenerator for a field.

Specified by:

getJsonGenerator in interface JsonConvertibleRecord

Parameters:

field - Json field.

Returns:

JsonGenerator predicate for field.

getJsonParser

public java.util.function.Predicate<com.fasterxml.jackson.core.JsonParser> getJsonParser(java.lang.String field)

Get the JsonParser for a field.

Specified by:

getJsonParser in interface JsonConvertibleRecord

Parameters:

field - Json field.

Returns:

JsonParser predicate for field.

dumpJSON

public java.lang.String dumpJSON()

Get the record in Json string format.

Specified by:

dumpJSON in interface JsonConvertibleRecord

Returns:

Json string representation of the record.

createIOMaps

protected abstract void createIOMaps()

Must be implemented in subclasses to define how fields, objects, arrays should be saved based on the Jackson streaming API.