review.classdesign.jammy.addons

Class DatasetBuilder

java.lang.Object

review.classdesign.jammy.addons.DatasetBuilder

public final class DatasetBuilder
extends java.lang.Object

A DatasetBuilder provides tools for extracting and creating sample dataset for a given Problem instance.

Author:

fv

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	DATASET_INPUT_SUFFIX Path of the created test input file.
private static java.lang.String	DATASET_OUTPUT_SUFFIX Path of the created test output file.
private org.eclipse.core.resources.IFolder	folder Target folder in which dataset will be written.
private static java.lang.String	INPUT_PATH Path of the input folder in which dataset will be written.
private static java.lang.String	IO_CLASSNAME Classname of the DIV that contains our testing dataset.
private static org.eclipse.core.runtime.IStatus	IO_NOT_FOUND Error status thrown when problem dataset could not be found.
private org.eclipse.core.runtime.IProgressMonitor	monitor Monitor instance used for project creation.
private Problem	problem Problem instance dataset is built from.
private org.eclipse.core.resources.IProject	project Target project contribution is made for.

Constructor Summary

Constructors

Constructor and Description
DatasetBuilder(Problem problem, org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor) Default constructor.

Method Summary

Modifier and Type	Method and Description
ProblemSampleDataset	build() Creates input and output dataset associated to the target problem instance.
private void	createFile(org.eclipse.core.resources.IFile file, java.lang.String content) Creates a dataset file for the target problem by writing given content into the given file.
private org.jsoup.nodes.Element	extractDataset() Extracts and returns the dataset from the problem body.
private org.eclipse.core.resources.IFile	getFile(java.lang.String suffix) Retrieves file associated to the given problem suffix.

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_PATH

private static final java.lang.String INPUT_PATH

Path of the input folder in which dataset will be written.

See Also:

Constant Field Values

IO_CLASSNAME

private static final java.lang.String IO_CLASSNAME

Classname of the DIV that contains our testing dataset.

See Also:

Constant Field Values

DATASET_INPUT_SUFFIX

private static final java.lang.String DATASET_INPUT_SUFFIX

Path of the created test input file.

See Also:

Constant Field Values

DATASET_OUTPUT_SUFFIX

private static final java.lang.String DATASET_OUTPUT_SUFFIX

Path of the created test output file.

See Also:

Constant Field Values

IO_NOT_FOUND

private static final org.eclipse.core.runtime.IStatus IO_NOT_FOUND

Error status thrown when problem dataset could not be found.

project

private final org.eclipse.core.resources.IProject project

Target project contribution is made for.

monitor

private final org.eclipse.core.runtime.IProgressMonitor monitor

Monitor instance used for project creation.

problem

private final Problem problem

Problem instance dataset is built from.

folder

private org.eclipse.core.resources.IFolder folder

Target folder in which dataset will be written.

Constructor Detail

DatasetBuilder

public DatasetBuilder(Problem problem,
                      org.eclipse.core.resources.IProject project,
                      org.eclipse.core.runtime.IProgressMonitor monitor)

Default constructor.

Parameters:

problem - Problem instance dataset is built from.

project - Target java project to be created.

monitor - Monitor instance used for project creation.

Method Detail

createFile

private void createFile(org.eclipse.core.resources.IFile file,
                        java.lang.String content)
                 throws org.eclipse.core.runtime.CoreException

Creates a dataset file for the target problem by writing given content into the given file.

Parameters:

file - File to write content info.

content - Content to write.

Throws:

org.eclipse.core.runtime.CoreException - If any error occurs while writing file.

getFile

private org.eclipse.core.resources.IFile getFile(java.lang.String suffix)

Retrieves file associated to the given problem suffix.

Parameters:

suffix - File name suffix to use for the retrieved file.

Returns:

Created file reference.

extractDataset

private org.jsoup.nodes.Element extractDataset()
                                        throws org.eclipse.core.runtime.CoreException

Extracts and returns the dataset from the problem body.

Returns:

HTML row element that contains our problem dataset.

Throws:

org.eclipse.core.runtime.CoreException - If any error occurs while extracing dataset.

build

public ProblemSampleDataset build()
                           throws org.eclipse.core.runtime.CoreException

Creates input and output dataset associated to the target problem instance.

Returns:

ProblemSampleDataset instance built.

Throws:

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