eu.planets_project.services.characterise
Interface Characterise

All Superinterfaces:

PlanetsService

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

Characterisation of one digital object. This is the generic characterisation interface for characterisation tools like the XCL Extractor and the New Zealand Metadata Extractor. It supports service description to facilitate discovery, allows parameters to be discovered and submitted to control the underlying tools (if needed).

Field Summary

static java.lang.String	NAME The service name.
static javax.xml.namespace.QName	QNAME The qualified name.

Method Summary

CharacteriseResult	characterise(DigitalObject digitalObject, java.util.List<Parameter> parameters)
java.util.List<Property>	listProperties(java.net.URI formatURI)

Methods inherited from interface eu.planets_project.services.PlanetsService

describe

Field Detail

NAME

static final java.lang.String NAME

The service name.

See Also:

Constant Field Values

QNAME

static final javax.xml.namespace.QName QNAME

The qualified name.

Method Detail

characterise

@RequestWrapper(className="eu.planets_project.services.characterise.CharacteriseCharacterise")
@ResponseWrapper(className="eu.planets_project.services.characterise.CharacteriseCharacteriseResponse")
CharacteriseResult characterise(DigitalObject digitalObject,
                                                               java.util.List<Parameter> parameters)

Parameters:

digitalObject - The digital object to characterise

parameters - for fine grained tool control

Returns:

A list of properties, wrapped into a CharacteriseResult

listProperties

@ResponseWrapper(className="eu.planets_project.services.characterise.CharacteriselistPropertiesResponse")
java.util.List<Property> listProperties(java.net.URI formatURI)

Parameters:

formatURI - A format URI

Returns:

The properties this characterisation service extracts for the given file format