review.classdesign.jammy.core

Class ProblemSolver

java.lang.Object

review.classdesign.jammy.common.NamedObject

review.classdesign.jammy.core.ProblemSolver

All Implemented Interfaces:

java.io.Serializable

public final class ProblemSolver
extends NamedObject

A ProblemSolver is an object that for a given Problem instance provides :

• An associated IFile which correspond to the solver source code
• An associated ProblemSampleDataset which contains testing input and output.

Author:

fv

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private ProblemSampleDataset	dataset Sample dataset associated to this solver.
private static java.lang.String	DATASET_TASK Task name for the dataset retrieval.
private static java.util.Map<Problem,java.lang.ref.SoftReference<ProblemSolver>>	INSTANCES Cache of all problem solver instances indexed by
private static java.lang.String	PROJECT_TASK Task name for the project retrieval.
private static long	serialVersionUID Serialization index.
private org.eclipse.core.resources.IFile	solver Target solver class file.
private static java.lang.String	SOLVER_TASK Task name for the solver retrieval.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ProblemSolver(java.lang.String name, org.eclipse.core.resources.IFile solver, ProblemSampleDataset dataset) Default constructor.

Method Summary

Modifier and Type	Method and Description
private static ProblemSolver	createSolver(Problem problem, org.eclipse.core.runtime.IProgressMonitor monitor) Static factory method that creates a ProblemSolver instance from the given problem instance.
static ProblemSolver	get(Problem problem, org.eclipse.core.runtime.IProgressMonitor monitor) ProblemSolver instances access method.
org.eclipse.core.resources.IFile	getFile() Getter for the solver class file.
org.eclipse.core.resources.IProject	getProject() Retrieves and returns IProject instance the solver class belongs to.
ProblemSampleDataset	getSampleDataset() Getter for the solver sample dataset.

Methods inherited from class review.classdesign.jammy.common.NamedObject

getName, getName

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serialization index.

See Also:

Constant Field Values

solver

private final org.eclipse.core.resources.IFile solver

Target solver class file.

dataset

private final ProblemSampleDataset dataset

Sample dataset associated to this solver.

INSTANCES

private static final java.util.Map<Problem,java.lang.ref.SoftReference<ProblemSolver>> INSTANCES

Cache of all problem solver instances indexed by

PROJECT_TASK

private static final java.lang.String PROJECT_TASK

Task name for the project retrieval.

See Also:

Constant Field Values

SOLVER_TASK

private static final java.lang.String SOLVER_TASK

Task name for the solver retrieval.

See Also:

Constant Field Values

DATASET_TASK

private static final java.lang.String DATASET_TASK

Task name for the dataset retrieval.

See Also:

Constant Field Values

Constructor Detail

ProblemSolver

private ProblemSolver(java.lang.String name,
                      org.eclipse.core.resources.IFile solver,
                      ProblemSampleDataset dataset)

Default constructor.

Parameters:

name - Name of the target project.

solver - Target solver class file.

dataset - Sample dataset associated to this solver.

Method Detail

getFile

public org.eclipse.core.resources.IFile getFile()

Getter for the solver class file.

Returns:

Target solver class file.

See Also:

solver

getProject

public org.eclipse.core.resources.IProject getProject()

Retrieves and returns IProject instance the solver class belongs to.

Returns:

IProject instance the solver class file belongs to.

See Also:

IResource.getProject()

getSampleDataset

public ProblemSampleDataset getSampleDataset()

Getter for the solver sample dataset.

Returns:

Sample dataset associated to this solver

See Also:

dataset

createSolver

private static ProblemSolver createSolver(Problem problem,
                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                   throws org.eclipse.core.runtime.CoreException

Static factory method that creates a ProblemSolver instance from the given problem instance. Creates project, solver, and dataset.

Parameters:

problem - Problem to build solver from.

monitor - Monitor instance used for each builder involved.

Returns:

Created solver instance.

Throws:

org.eclipse.core.runtime.CoreException - If any error occurs while creating solver.

get

public static ProblemSolver get(Problem problem,
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException

ProblemSolver instances access method. If the required instance does not exist, or has been garbaged, then a new instance is created and put into the local cache.

Parameters:

problem - Problem to get solver instance from.

monitor - Monitor instance used if solver creation is required.

Returns:

Retrieved instance.

Throws:

org.eclipse.core.runtime.CoreException - If any error occurs while creating required instance.