com.emphysic.myriad.core.data.util

Interface ObjectMap

All Superinterfaces:

com.esotericsoftware.kryo.KryoSerializable

All Known Subinterfaces:

DatasetOperation, MLROIFinder, ROIFinder

All Known Implementing Classes:

AbsoluteValueOperation, AdaptiveSGDROIFinder, BinarizeOperation, BlurOperation, BoxBlur, CannyOperation, ChainedDatasetOperation, ConvolutionOperation, DifferenceOfGaussiansOperation, ExternalROIFinder, FeatureScalingOperation, GaussianBlur, GaussianPyramidOperation, GradMachineROIFinder, HOGOperation, MLROIConfFinder, NormalizeSignalOperation, OCLConvolutionOperation, Otsu1dOperation, PassiveAggressiveROIFinder, PowerOfTwoOperation, PrewittOperation, RESTROIFinder, ROIBundle, ScalingOperation, ScharrOperation, SGDROIFinder, SlidingWindowOperation, SobelOperation, SVMROIFinder, UpscaleOperation

public interface ObjectMap
extends com.esotericsoftware.kryo.KryoSerializable

ObjectMap - Kryo serialization of an instance's object graph. Created by ccoughlin on 4/4/2017.

Method Summary

Modifier and Type	Method and Description
default java.util.Map<java.lang.String,java.lang.Object>	getObjectMap() Creates a map of the important fields for the instance, suitable for serialization.
long	getSerializationVersion() Returns the current version of the serialization format.
int	getVersion() Returns the current class version.
default void	init(java.util.Map<java.lang.String,java.lang.Object> objectMap) Initializes an instance with an object map.
void	initCurrentVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap) Initializes an instance with a current-version object graph.
default void	initPreviousVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap, int version) Handles requests to initialize an instance with a previous version of an object graph.
default void	initUnknownVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap, int version) Handles requests to initialize an instance with an unknown (future, undefined, etc.) version of an object graph.
default void	load(java.io.File inFile) Reads a model from disk
default void	read(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Input input) Reads a Kryo-serialized object graph.
default void	save(java.io.File outFile) Saves a model to disk
default void	write(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Output output) Serializes the current instance as a Kryo object.

Method Detail

getSerializationVersion

long getSerializationVersion()

Returns the current version of the serialization format. Increments when the serialization format changes, i.e. backwards compatibility is broken.

Returns:

serialization version

getVersion

int getVersion()

Returns the current class version. Class version increments when the class changes but doesn't necessarily break compatibility with serialization.

Returns:

class version

getObjectMap

default java.util.Map<java.lang.String,java.lang.Object> getObjectMap()

Creates a map of the important fields for the instance, suitable for serialization.

Returns:

"object map" of the instance

init

default void init(java.util.Map<java.lang.String,java.lang.Object> objectMap)

Initializes an instance with an object map.

Parameters:

objectMap - Map of field:value pairs

Throws:

java.lang.UnsupportedOperationException - if serialization versions don't match

initCurrentVersion

void initCurrentVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap)

Initializes an instance with a current-version object graph.

Parameters:

objectMap - object graph for initialization

initPreviousVersion

default void initPreviousVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap,
                                 int version)

Handles requests to initialize an instance with a previous version of an object graph. Default action is no-op.

Parameters:

objectMap - object graph for initialization

version - version of object graph

initUnknownVersion

default void initUnknownVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap,
                                int version)

Handles requests to initialize an instance with an unknown (future, undefined, etc.) version of an object graph. Default action is to throw UnsupportedOperationException.

Parameters:

objectMap - object graph

version - version

Throws:

java.lang.UnsupportedOperationException - by default

save

default void save(java.io.File outFile)
           throws java.io.IOException

Saves a model to disk

Parameters:

outFile - destination file

Throws:

java.io.IOException - if an I/O error occurs (file not found, insufficient permissions, etc.)

load

default void load(java.io.File inFile)
           throws java.io.IOException

Reads a model from disk

Parameters:

inFile - source file

Throws:

java.io.IOException - if an I/O error occurs (file not found, insufficient permissions, etc.)

read

default void read(com.esotericsoftware.kryo.Kryo kryo,
                  com.esotericsoftware.kryo.io.Input input)

Reads a Kryo-serialized object graph.

Specified by:

read in interface com.esotericsoftware.kryo.KryoSerializable

Parameters:

kryo - Kryo instance

input - Input

write

default void write(com.esotericsoftware.kryo.Kryo kryo,
                   com.esotericsoftware.kryo.io.Output output)

Serializes the current instance as a Kryo object.

Specified by:

write in interface com.esotericsoftware.kryo.KryoSerializable

Parameters:

kryo - Kryo instance

output - Output