edu.kit.iti.lfm.spotlight

Class Field

java.lang.Object

edu.kit.iti.lfm.spotlight.Field

public final class Field
extends Object

This class represents a single field on a Spotlight Board.

Each field is marked with (a) a number (called the constraint) and (b) an arrow (called the direction). Additionally, fields may have colors: They can be either black or white or uncolored. There are eight different arrows which are enumerated in Field.Direction. Each field is addressed by two coordinates row and column denoting the row and and the column within the board.

Author:

Mattias Ulbrich, David Farago

See Also:

Board

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.Direction This enumeration lists the possible directions for arrows in fields of Boards.
static class	Field.FieldColor This declaration enumerates the colors that a field can take.

Constructor Summary

Constructors

Constructor and Description
Field(int rowParam, int columnParam, int constraintParam, Field.Direction directionParam, Field.FieldColor colorParam) Instantiates a new field.

Method Summary

Methods

Modifier and Type	Method and Description
Field.FieldColor	getColor() Gets the color of this field.
int	getColumn() Gets the column on the board.
int	getColumnOffset() Gets the column component of the direction of the arrow as an offset.
int	getConstraint() Gets the constraint of this field.
Field.Direction	getDirection() Gets the direction.
List<Field>	getRegion(Board board) Get the region of Fields this field points to.
int	getRow() Gets the row of this field on the board.
int	getRowOffset() Gets the row component of the direction of the arrow as an offset.
int	getSequentialIndex(Board board) The sequential index of this field in the board given by the parameter, e.g. for usage as propositional atom.
void	setColor(Field.FieldColor newColor) Sets the color of this field.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Field

public Field(int rowParam,
     int columnParam,
     int constraintParam,
     Field.Direction directionParam,
     Field.FieldColor colorParam)

Instantiates a new field.

Parameters:

rowParam - the row of this field on the board.

columnParam - the column of this field on the board.

constraintParam - the constraint in the arrow of this field.

directionParam - the direction of the arrow on this field.

Method Detail

getRow

public int getRow()

Gets the row of this field on the board.

Returns:

the row of this field on the board (a positive integer).

getColumn

public int getColumn()

Gets the column on the board.

Returns:

the column of this field on the board (a positive integer).

getDirection

public Field.Direction getDirection()

Gets the direction.

Returns:

the direction that the arrow of this field points to.

getRowOffset

public int getRowOffset()

Gets the row component of the direction of the arrow as an offset.

Returns:

the row offset, which is -1, 0, or -1, but not 0 if getColumnOffset() == 0.

getColumnOffset

public int getColumnOffset()

Gets the column component of the direction of the arrow as an offset.

Returns:

the column offset, which is -1, 0, or -1, but not 0 if getRowOffset() == 0.

getConstraint

public int getConstraint()

Gets the constraint of this field.

Returns:

the constraint that this field is posing, i.e. the non-negative number within the Field.

getRegion

public List<Field> getRegion(Board board)

Get the region of Fields this field points to.

The region is the list of Fields to which the arrow in this field points to. This field itself is not included in the result. This convenient method simply delegates to Board.getRegionForField(int, int).

Returns:

a freshly created list of the fields that the arrow on this field points to.

getSequentialIndex

public int getSequentialIndex(Board board)

The sequential index of this field in the board given by the parameter, e.g. for usage as propositional atom. This convenient method simply delegates to Board.getSequentialIndex(Field). So if board.containsCoordinates(this.getRow(), this.getColumn()) is met, its sequentialIndex is returned, even if this Field is not actually on the board.

Returns:

a freshly created list of the fields that the arrow on this field points to.

Throws:

IllegalArgumentException - if board.containsCoordinates(this.getRow(), this.getColumn()) is not met.

getColor

public Field.FieldColor getColor()

Gets the color of this field. This method may return null indicating an uncolored field.

Returns:

the color of this field (i.e. Field.FieldColor.BLACK or Field.FieldColor.WHITE), null for uncolored.

setColor

public void setColor(Field.FieldColor newColor)

Sets the color of this field. If the parameter is null, the field is marked "uncolored". Field.FieldColor.BLACK

Parameters:

newColor - the new color of this field (i.e. Field.FieldColor.BLACK or Field.FieldColor.WHITE), null for uncolored.

toString

public String toString()

Overrides:

toString in class Object