Algorithm (Ambit 2 4.0.1-SNAPSHOT API)

java.lang.Object
- ambit2.core.data.model.Algorithm<T>

All Implemented Interfaces:

Serializable, Comparable<Algorithm<T>>
```
public class Algorithm<T extends Serializable>
extends Object
implements Comparable<Algorithm<T>>, Serializable
```
Quick implementation of OpenTox Algorithm spec

Author:

nina

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Algorithm.AlgorithmFormat

static class Algorithm.requires

Nested Classes
Modifier and Type	Class and Description
`static class`	`Algorithm.AlgorithmFormat`
`static class`	`Algorithm.requires`

Field Summary

Fields
Modifier and Type	Field and Description
`protected T`	`content`
`protected String`	`description`
`protected String`	`endpoint`
`protected Algorithm.AlgorithmFormat`	`format`
`protected String`	`id`
`protected String`	`implementationOf`
`protected Template`	`input`
`protected String`	`name`
`protected List<Parameter>`	`parameters`
`protected Algorithm.requires`	`requirement`
`protected String[]`	`type`

Constructor Summary

Constructors
Constructor and Description

Algorithm()

Algorithm(String name)

Constructors
Constructor and Description
`Algorithm()`
`Algorithm(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParameter(Parameter param)`
`int`	`compareTo(Algorithm<T> o)`
`boolean`	`equals(Object obj)`
`T`	`getContent()`
`String`	`getDescription()`
`String`	`getEndpoint()`
`Algorithm.AlgorithmFormat`	`getFormat()`
`String`	`getId()`
`String`	`getImplementationOf()`
`Template`	`getInput()`
`String`	`getName()`
`List<Parameter>`	`getParameters()`
`String[]`	`getParametersAsArray()`
`Algorithm.requires`	`getRequirement()`
`String[]`	`getType()`
`boolean`	`hasType(AlgorithmType type)`
`boolean`	`hasType(String type)`
`boolean`	`isDataProcessing()`
`boolean`	`isRequiresDataset()`
`boolean`	`isSupervised()`
`void`	`setContent(T content)`
`void`	`setDescription(String description)`
`void`	`setEndpoint(String endpoint)`
`void`	`setFormat(Algorithm.AlgorithmFormat format)`
`void`	`setId(String id)`
`void`	`setImplementationOf(String implementationOf)`
`void`	`setInput(Template input)`
`void`	`setName(String name)`
`void`	`setParameters(List<Parameter> parameters)`
`void`	`setRequirement(Algorithm.requires requirement)`
`void`	`setType(String[] type)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id
```
protected String id
```

name
```
protected String name
```

parameters
```
protected List<Parameter> parameters
```

content

protected T extends Serializable content

format

protected Algorithm.AlgorithmFormat format

type
```
protected String[] type
```

endpoint
```
protected String endpoint
```

requirement

protected Algorithm.requires requirement

implementationOf
```
protected String implementationOf
```

description
```
protected String description
```

input
```
protected Template input
```

Constructor Detail

Algorithm
```
public Algorithm()
```

Algorithm
```
public Algorithm(String name)
```

Method Detail

getImplementationOf
```
public String getImplementationOf()
```

setImplementationOf

public void setImplementationOf(String implementationOf)

getRequirement

public Algorithm.requires getRequirement()

setRequirement

public void setRequirement(Algorithm.requires requirement)

getEndpoint
```
public String getEndpoint()
```

setEndpoint

public void setEndpoint(String endpoint)

isSupervised
```
public boolean isSupervised()
```

isRequiresDataset
```
public boolean isRequiresDataset()
```

isDataProcessing
```
public boolean isDataProcessing()
```

getType
```
public String[] getType()
```

setType
```
public void setType(String[] type)
```

hasType

public boolean hasType(AlgorithmType type)

hasType
```
public boolean hasType(String type)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getFormat

public Algorithm.AlgorithmFormat getFormat()

setFormat

public void setFormat(Algorithm.AlgorithmFormat format)

getInput
```
public Template getInput()
```

setInput
```
public void setInput(Template input)
```

getContent
```
public T getContent()
```

setContent
```
public void setContent(T content)
```

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getParameters

public List<Parameter> getParameters()

setParameters

public void setParameters(List<Parameter> parameters)

addParameter

public void addParameter(Parameter param)

toString
```
public String toString()
```
Overrides:

toString in class Object

compareTo
```
public int compareTo(Algorithm<T> o)
```
Specified by:

compareTo in interface Comparable<Algorithm<T extends Serializable>>

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

getParametersAsArray

public String[] getParametersAsArray()

Class Algorithm<T extends Serializable>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

parameters

content

format

type

endpoint

requirement

implementationOf

description

input

Constructor Detail

Algorithm

Algorithm

Method Detail

getImplementationOf

setImplementationOf

getRequirement

setRequirement

getEndpoint

setEndpoint

isSupervised

isRequiresDataset

isDataProcessing

getType

setType

hasType

hasType

getDescription

setDescription

getFormat

setFormat

getInput

setInput

getContent

setContent

getId

setId

getName

setName

getParameters

setParameters

addParameter

toString

compareTo

equals

getParametersAsArray