eu.planets_project.services.compare
Interface CompareProperties

All Superinterfaces:

PlanetsService

@MTOM
@StreamingAttachment(parseEagerly=true,
                     memoryThreshold=10485760L)
public interface CompareProperties
extends PlanetsService

Comparison of CharacteriseResult objects (the output of the Characterise interface).

Author:

Fabian Steeg (fabian.steeg@uni-koeln.de)

See Also:

Characterise

Field Summary

static String	NAME
static QName	QNAME

Method Summary

CompareResult	compare(CharacteriseResult first, CharacteriseResult second, List<Parameter> config)
List<Parameter>	convertConfig(DigitalObject configFile) Convert a tool-specific configuration file to the generic format of a list of properties.
CharacteriseResult	convertInput(DigitalObject inputFile) Convert a tool-specific input file (like the output of a characterisation tool) to the generic format the service uses.

Methods inherited from interface eu.planets_project.services.PlanetsService

describe

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

QNAME

static final QName QNAME

Method Detail

compare

@RequestWrapper(className="eu.planets_project.services.compare.ComparePropertiesRequest")
@ResponseWrapper(className="eu.planets_project.services.compare.ComparePropertiesResponse")
CompareResult compare(CharacteriseResult first,
                                                     CharacteriseResult second,
                                                     List<Parameter> config)

Parameters:

first - The first of the two CharacteriseResult objects to compare

second - The second of the two CharacteriseResult objects to compare

config - A configuration parameter list

Returns:

A list of result properties, the result of comparing the given digital object, wrapped in a result object

convertInput

CharacteriseResult convertInput(DigitalObject inputFile)

Convert a tool-specific input file (like the output of a characterisation tool) to the generic format the service uses. Use this method to pass as the first two arguments to compare(CharacteriseResult, CharacteriseResult, List).

Parameters:

inputFile - The tool-specific configuration file

Returns:

A CharacteriseResult object representing the given input file

convertConfig

List<Parameter> convertConfig(DigitalObject configFile)

Convert a tool-specific configuration file to the generic format of a list of properties. Use this method to pass your configuration file as the last argument to compare(CharacteriseResult, CharacteriseResult, List).

Parameters:

configFile - The tool-specific configuration file

Returns:

A list of parameters containing the configuration values