eu.planets_project.services.datatypes
Class Tool

java.lang.Object
  eu.planets_project.services.datatypes.Tool

public final class Tool
extends java.lang.Object

A richer tool description, so that the system can work in the absence of a tool registry.

Constructor Summary

Tool(java.net.URI identifier, java.lang.String name, java.lang.String version, java.lang.String description, java.net.URL homepage)

Method Summary

static Tool	create(java.net.URI identifier, java.lang.String name, java.lang.String version, java.lang.String description, java.lang.String homepageUrl) If you specify a tool registry URI, then any information stored in the registry will be used to fill in the gaps.
java.lang.String	getDescription()
java.net.URL	getHomepage()
java.net.URI	getIdentifier()
java.lang.String	getName()
java.lang.String	getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

Tool

public Tool(java.net.URI identifier,
            java.lang.String name,
            java.lang.String version,
            java.lang.String description,
            java.net.URL homepage)

Parameters:

identifier - An identifier that resolves this tool via a tool registry. Set to NULL if not in a registry.

name - The name of this tool.

version - The version number of this tool. NULL if unknown.

description - A tool description

homepage - A link to the tool homepage.

Method Detail

getDescription

public java.lang.String getDescription()

Returns:

the description

getHomepage

public java.net.URL getHomepage()

Returns:

the homepage

getIdentifier

public java.net.URI getIdentifier()

Returns:

the identifier

getName

public java.lang.String getName()

Returns:

the name

getVersion

public java.lang.String getVersion()

Returns:

the version

create

public static Tool create(java.net.URI identifier,
                          java.lang.String name,
                          java.lang.String version,
                          java.lang.String description,
                          java.lang.String homepageUrl)

If you specify a tool registry URI, then any information stored in the registry will be used to fill in the gaps. If there is no registry URI, then you should specify at least a name and version. All params can be null if unknown.

Parameters:

identifier - An identifier resolvable via a tool registry.

name - The tool name.

version - The tool version.

description - An optional description of the tool.

homepageUrl - An optional pointer to the homepage of the tool.

Returns:

A Tool instance for the given values