com.languagecomputer.api
Interface AnnotationMetaService

All Superinterfaces:

Service

All Known Implementing Classes:

AnnotationMetaServiceWebClient, DefaultAnnotationMetaService

public interface AnnotationMetaService
extends Service

A meta-Service that processes a single Document with a given list of other Services.

Since:

1.0

Author:

Kirk Roberts

Method Summary

void	annotate(Document document, List<String> services) Process the given Document with the given services.
AnnotationType	getAnnotationType(String service) Returns the AnnotationType that corresponds to the given service.
Document	process(URL url, String fileType, List<String> services) Process the given URL of the given type, then annotate the given services.

Methods inherited from interface com.languagecomputer.api.Service

getName, setSession

Method Detail

process

Document process(URL url,
                 String fileType,
                 List<String> services)
                 throws IOException

Process the given URL of the given type, then annotate the given services.

Parameters:

url - java.net.URL of the file to process.

fileType - (Advanced Users) Optional file type to force.

Returns:

A processed Document corresponding to the given url.

Throws:

IOException - If there was a problem reading the URL.

annotate

void annotate(Document document,
              List<String> services)

Process the given Document with the given services.

Parameters:

document - Document to process.

services - List of services to run. In most cases, the services should be run in the order specified, unless a re-order is necessary for dependencies.

getAnnotationType

AnnotationType getAnnotationType(String service)

Returns the AnnotationType that corresponds to the given service. Returns null if the service is not recognized.

Parameters:

service - Name of the Service.

Returns:

The AnnotationType the given service is responsible for.