de.mpg.biochem.mars.molecule

Interface JsonConvertibleRecord

All Known Subinterfaces:

MarsMetadata, MarsRecord, Molecule, MoleculeArchive<M,I,P,X>, MoleculeArchiveIndex<M,I>, MoleculeArchiveProperties<M,I>

All Known Implementing Classes:

AbstractJsonConvertibleRecord, AbstractMarsMetadata, AbstractMarsRecord, AbstractMolecule, AbstractMoleculeArchive, AbstractMoleculeArchiveIndex, AbstractMoleculeArchiveProperties, DefaultJsonConverter, DefaultMolecule, DefaultMoleculeArchive, DefaultMoleculeArchiveIndex, DefaultMoleculeArchiveProperties, DnaMolecule, DnaMoleculeArchive, DnaMoleculeArchiveIndex, DnaMoleculeArchiveProperties, MarsBdvSource, MarsDocument, MarsOMEChannel, MarsOMEImage, MarsOMEMetadata, MarsOMEPlane, MarsPosition, MarsRegion, MarsTable, MartianObject, ObjectArchive, ObjectArchiveIndex, ObjectArchiveProperties, OLDMarsMetadata, Peak, PeakShape, SingleMolecule, SingleMoleculeArchive, SingleMoleculeArchiveIndex, SingleMoleculeArchiveProperties

public interface JsonConvertibleRecord

Interface for objects that are Json serialized and deserialized.

Method Summary

Modifier and Type	Method and Description
java.lang.String	dumpJSON() Get the record in Json string format.
void	fromJSON(com.fasterxml.jackson.core.JsonParser jParser) Deserializes an instance of the implementing class from JSON using the JsonParser provided.
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) Serializes the implementing class to JSON using the JsonGenerator provided.

Method Detail

toJSON

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

Serializes the implementing class to JSON using the JsonGenerator provided.

Parameters:

jGenerator - JsonGenerator stream to read Json from.

Throws:

java.io.IOException - Thrown if unable to write to JsonGenerator.

fromJSON

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

Deserializes an instance of the implementing class from JSON using the JsonParser provided.

Parameters:

jParser - JsonParser stream to write Json to.

Throws:

java.io.IOException - Thrown if unable to read from JsonParser.

setShowWarnings

void setShowWarnings(boolean showWarnings)

setJsonField

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)

getJsonGenerator

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

Get the JsonGenerator for a field.

Parameters:

field - Json field.

Returns:

JsonGenerator predicate for field.

getJsonParser

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

Get the JsonParser for a field.

Parameters:

field - Json field.

Returns:

JsonParser predicate for field.

dumpJSON

java.lang.String dumpJSON()

Get the record in Json string format.

Returns:

Json string representation of the MarsMetadata record.