org.trippi
Class ConnectorParameter

java.lang.Object
  org.trippi.ConnectorParameter

public class ConnectorParameter
extends java.lang.Object

A parameter to a TriplestoreConnector.

Instances of this class document the nature of a parameter, the values it may have, and the other parameters that are valid only in the context of a certain value of this one.

For example, consider the remote parameter to a triplestore, indicating whether it is accessed via the network or the filesystem. In the case that remote is true, the parameters hostname and port would be needed. In the case where it is false, a path parameter would be needed.

Author:

cwilper@cs.cornell.edu

Constructor Summary

ConnectorParameter(java.lang.String name, java.lang.String label, java.lang.String description, boolean isOptional, java.util.List options, java.util.Map parameterMap)

Method Summary

java.lang.String	getDescription() A longer description of the parameter.
java.lang.String	getLabel() A simple description of the parameter.
java.lang.String	getName() The name of the parameter.
java.util.List	getOptions() Get the value options for this parameter.
java.util.List	getParameters(java.lang.String value) For a given value of this parameter, get the list of additional ConnectorParameters that should be considered.
boolean	isOptional() Whether the parameter may be unspecified.
java.lang.String	toString()
java.lang.String	toString(int i)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectorParameter

public ConnectorParameter(java.lang.String name,
                          java.lang.String label,
                          java.lang.String description,
                          boolean isOptional,
                          java.util.List options,
                          java.util.Map parameterMap)

Method Detail

getName

public java.lang.String getName()

The name of the parameter.

getLabel

public java.lang.String getLabel()

A simple description of the parameter.

getDescription

public java.lang.String getDescription()

A longer description of the parameter.

isOptional

public boolean isOptional()

Whether the parameter may be unspecified.

getOptions

public java.util.List getOptions()

Get the value options for this parameter. If the array is non-empty, it can be assumed that it contains all possible valid values for the parameter. Otherwise, its value will be considered open-ended.

getParameters

public java.util.List getParameters(java.lang.String value)

For a given value of this parameter, get the list of additional ConnectorParameters that should be considered.

Returns:

the List of parameters (may be empty).

toString

public java.lang.String toString(int i)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object