com.asakusafw.iterative.common

Interface ParameterTable

All Superinterfaces:

Iterable<ParameterSet>

All Known Implementing Classes:

BasicParameterTable

public interface ParameterTable
extends Iterable<ParameterSet>

Represents a parameter table.

Since:

0.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ParameterTable.Builder A builder for ParameterTable.
static interface	ParameterTable.Cursor A cursor over ParameterTable.

Method Summary

Modifier and Type	Method and Description
Set<String>	getAvailable() Returns the all available parameter names in this set.
Set<String>	getPartial() Returns the partial parameter names in this set.
int	getRowCount() Returns the number of rows in this table.
List<ParameterSet>	getRows() Returns all rows in this table.
boolean	isEmpty() Returns whether this table is empty or not.
ParameterTable.Cursor	newCursor() Returns a new cursor for iterate each row.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

isEmpty

boolean isEmpty()

Returns whether this table is empty or not.

Returns:

true if this table is empty, otherwise false

getRowCount

int getRowCount()

Returns the number of rows in this table.

Returns:

the number of rows, or 0 if this table is empty

newCursor

ParameterTable.Cursor newCursor()

Returns a new cursor for iterate each row.

Returns:

the created cursor

getAvailable

Set<String> getAvailable()

Returns the all available parameter names in this set.

Returns:

the all available parameter names

getPartial

Set<String> getPartial()

Returns the partial parameter names in this set. Partial parameters will not available in some rounds.

Returns:

the partial parameter names

getRows

List<ParameterSet> getRows()

Returns all rows in this table.

Returns:

all rows