com.dna.jopt.io.importing

Interface IOptimizationImporter

All Superinterfaces:

IJOptImporter<IOptimization>

All Known Implementing Classes:

OptimizationJSONImporter

public interface IOptimizationImporter
extends IJOptImporter<IOptimization>

The Interface IOptimizationImporter.

Since:

Sep 26, 2019

Version:

Sep 26, 2019

Author:

Jens Richter

Method Summary

Modifier and Type	Method and Description
Optional<IOptimization>	read(InputStream fis) Read.
boolean	update(InputStream fis, IOptimization existingOpti) Takes an existing IOptimization instance and updates it with an optimization from an InputStream.
boolean	update(InputStream fis, IOptimization existingOpti, boolean isIgnoreExistingSolution) Takes an existing IOptimization instance and updates it with an optimization from an InputStream.
boolean	update(InputStream fis, IOptimization existingOpti, Optional<INodeEdgeConnector> existingNodeConnector, Properties existingProperties, boolean isOnlyPropertyUpdate) Takes an existing IOptimization instance and updates it with an optimization from an InputStream.
boolean	update(InputStream fis, IOptimization existingOpti, Optional<INodeEdgeConnector> existingNodeConnector, Properties existingProperties, boolean isOnlyPropertyUpdate, boolean isIgnoreExistingSolution) Takes an existing IOptimization instance and updates it with an optimization from an InputStream.

Method Detail

read

Optional<IOptimization> read(InputStream fis)

Read.

Specified by:

read in interface IJOptImporter<IOptimization>

Parameters:

fis - the fis

Returns:

the optional

update

boolean update(InputStream fis,
               IOptimization existingOpti)

Takes an existing IOptimization instance and updates it with an optimization from an InputStream.

Parameters:

fis - the InputStream

existingOpti - the existing optimization

Returns:

true, if successful

update

boolean update(InputStream fis,
               IOptimization existingOpti,
               boolean isIgnoreExistingSolution)

Takes an existing IOptimization instance and updates it with an optimization from an InputStream. If isIgnoreExistingSolution is true, the existing solution of the snapshot will be ignored.

Parameters:

fis - the fis

existingOpti - the existing opti

isIgnoreExistingSolution - the is ignore existing solution

Returns:

true, if successful

update

boolean update(InputStream fis,
               IOptimization existingOpti,
               Optional<INodeEdgeConnector> existingNodeConnector,
               Properties existingProperties,
               boolean isOnlyPropertyUpdate)

Takes an existing IOptimization instance and updates it with an optimization from an InputStream. Further, an INodeEdgeConnector can be provided to replace it with the one from the InputStream. Additional, properties must be provided. If isOnlyPropertyUpdate==true the provided properties are used to update the properties from the InputStream. If isOnlyPropertyUpdate==false the provided properties are used to replace the property settings from the InputStream.

Parameters:

fis - the InputStream

existingOpti - the existing optimization

existingNodeConnector - an existing node connector

existingProperties - the existing properties

isOnlyPropertyUpdate - the is only property update

Returns:

true, if successful

update

boolean update(InputStream fis,
               IOptimization existingOpti,
               Optional<INodeEdgeConnector> existingNodeConnector,
               Properties existingProperties,
               boolean isOnlyPropertyUpdate,
               boolean isIgnoreExistingSolution)

Takes an existing IOptimization instance and updates it with an optimization from an InputStream. Further, an INodeEdgeConnector can be provided to replace it with the one from the InputStream. Additional, properties must be provided. If isOnlyPropertyUpdate==true the provided properties are used to update the properties from the InputStream. If isOnlyPropertyUpdate==false the provided properties are used to replace the property settings from the InputStream. If isIgnoreExistingSolution is true, the existing solution of the snapshot will be ignored.

Parameters:

fis - the fis

existingOpti - the existing opti

existingNodeConnector - the existing node connector

existingProperties - the existing properties

isOnlyPropertyUpdate - the is only property update

isIgnoreExistingSolution - the is ignore existing solution

Returns:

true, if successful