de.tif.jacob.core.definition
Class Filldirection

java.lang.Object
  de.tif.jacob.core.definition.Filldirection

public final class Filldirection
extends java.lang.Object

This class declares the different kinds of fill directions. A fill direction is used to determine in which direction(s) a record propagation should be executed.

See Also:

IDataAccessor.propagateRecord(IDataRecord, Filldirection), IDataAccessor.propagateRecord(IDataRecord, IRelationSet, Filldirection)

Field Summary

static Filldirection	BACKWARD The instance for backward fill direction.
static Filldirection	BOTH The instance for indicating that either forward and backward should be used as fill directions.
static Filldirection	FORWARD The instance for forward fill direction.
static Filldirection	NONE The instance for indicating that no fill direction exists.
static java.lang.String	RCS_ID The internal revision control system id.
static java.lang.String	RCS_REV The internal revision control system id in short form.

Method Summary

static Filldirection	fromJad(CastorFilldirection jadType) Internal method for converting a XML JAD type to this class.
boolean	isBackward() Checks whether this fill direction includes backward direction.
boolean	isForward() Checks whether this fill direction includes forward direction.
static Filldirection	parseFilldirection(java.lang.String direction) Parses the hands over string to a valid Filldirection object.
CastorFilldirection	toJad() Internal method for converting this fill direction to the corresponding XML JAD type.
java.lang.String	toString() Returns a string representation of this fill direction, which is easy for a person to read.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

NONE

public static final Filldirection NONE

The instance for indicating that no fill direction exists.

BOTH

public static final Filldirection BOTH

The instance for indicating that either forward and backward should be used as fill directions.

FORWARD

public static final Filldirection FORWARD

The instance for forward fill direction.

BACKWARD

public static final Filldirection BACKWARD

The instance for backward fill direction.

Method Detail

fromJad

public static Filldirection fromJad(CastorFilldirection jadType)

Internal method for converting a XML JAD type to this class.

Parameters:

jadType - the XML JAD type

Returns:

the resulting fill direction instance

isForward

public boolean isForward()

Checks whether this fill direction includes forward direction.

Returns:

true if forward direction is included, otherwise false

isBackward

public boolean isBackward()

Checks whether this fill direction includes backward direction.

Returns:

true if backward direction is included, otherwise false

parseFilldirection

public static Filldirection parseFilldirection(java.lang.String direction)

Parses the hands over string to a valid Filldirection object.

Parameters:

direction - the fill direction string to parse

Returns:

The Filldirection object or BACKWARD if no valid mapping possible.

toString

public java.lang.String toString()

Returns a string representation of this fill direction, which is easy for a person to read.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this fill direction.

toJad

public CastorFilldirection toJad()

Internal method for converting this fill direction to the corresponding XML JAD type.

Returns:

the XML JAD type