org.apache.manifoldcf.core.interfaces
Class ResultSpecification

java.lang.Object
  org.apache.manifoldcf.core.interfaces.ResultSpecification

public class ResultSpecification
extends java.lang.Object

An instance of this class is used to specify the result form of a column, if more than one form is possible. If no form is specified, then a default form will be used.

Nested Class Summary

protected static class

ResultSpecification.ColumnSpecification

Field Summary

protected java.util.HashMap	columnSpecifications This map has a column name as a key, and a ColumnSpecification object as a value
static int	FORM_DEFAULT
static int	FORM_STREAM
static int	FORM_STRING

Constructor Summary

ResultSpecification()
Constructor

Method Summary

boolean	equals(java.lang.Object o) Check equals
int	getForm(java.lang.String columnName) Get the specified form of a column
int	hashCode() Calculate a hash value
void	setForm(java.lang.String columnName, int formValue) Specify that a column is to be read as a file stream, if possible
java.lang.String	toString() Convert to a unique string

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FORM_DEFAULT

public static final int FORM_DEFAULT

See Also:

Constant Field Values

FORM_STRING

public static final int FORM_STRING

See Also:

Constant Field Values

FORM_STREAM

public static final int FORM_STREAM

See Also:

Constant Field Values

columnSpecifications

protected java.util.HashMap columnSpecifications

This map has a column name as a key, and a ColumnSpecification object as a value

Constructor Detail

ResultSpecification

public ResultSpecification()

Constructor

Method Detail

hashCode

public int hashCode()

Calculate a hash value

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Check equals

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Convert to a unique string

Overrides:

toString in class java.lang.Object

setForm

public void setForm(java.lang.String columnName,
                    int formValue)

Specify that a column is to be read as a file stream, if possible

getForm

public int getForm(java.lang.String columnName)

Get the specified form of a column