All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.beans.tools.dataFormatWizard.RepeatAttribute

public interface interface RepeatAttribute
extends PropertyChangeAnnouncer
The RepeatAttribute interface is used by schema items whose instances can read more than one value from the input stream.

Schema items which implement this interface will have a repeat type property and a repeat test property.

The repeat type determines whether an instance is to be read once, read a fixed number of times, or read while a boolean condition is met.

If the item is to be read a fixed number of times, the repeat test will indicate the number of times to read the item.

If the item is to be read while a boolean condition is met, the repeat test will indicate the condition for continuing to read the item.

See Also:
SchemaItem

Variable Index

 o REPEAT_N_TIMES
Indicates that the schema item should be read n times, where n is defined by a user-provided expression.
 o REPEAT_ONCE
Indicates that the schema item should be read exactly once.
 o REPEAT_TEST_PROPERTY
Indicates changes in the repeat test for this schema item.
 o REPEAT_TEST_UNSPECIFIED
Indicates an unspecified value for the repeat test for this schema item.
 o REPEAT_TYPE_PROPERTY
Indicates changes in the repeat type for this schema item.
 o REPEAT_UNTIL_EOB
Indicates that the schema item should be read an arbitrary number of times, until the end of the current block is reached.
 o REPEAT_UNTIL_EOF
Indicates that the schema item should be read an arbitrary number of times, until the end of the input stream is reached.
 o REPEAT_UNTIL_X
Indicates that the schema item should be read an arbitrary number of times, until a user-provided boolean expression is true.
 o REPEAT_WHILE_X
Indicates that the schema item should be read an arbitrary number of times, while a user-provided boolean expression is true.

Method Index

 o getRepeatTest()
Gets the repeat test for this schema item.
 o getRepeatType()
Gets the repeat type for this schema item.
 o setRepeatTest(String)
Sets the repeat test for this schema item.
 o setRepeatType(byte)
Sets the repeat type for this schema item.

Variables

 o REPEAT_TYPE_PROPERTY
 public static final String REPEAT_TYPE_PROPERTY
Indicates changes in the repeat type for this schema item.

 o REPEAT_TEST_PROPERTY
 public static final String REPEAT_TEST_PROPERTY
Indicates changes in the repeat test for this schema item.

 o REPEAT_ONCE
 public static final byte REPEAT_ONCE
Indicates that the schema item should be read exactly once.

 o REPEAT_N_TIMES
 public static final byte REPEAT_N_TIMES
Indicates that the schema item should be read n times, where n is defined by a user-provided expression.

 o REPEAT_WHILE_X
 public static final byte REPEAT_WHILE_X
Indicates that the schema item should be read an arbitrary number of times, while a user-provided boolean expression is true.

 o REPEAT_UNTIL_X
 public static final byte REPEAT_UNTIL_X
Indicates that the schema item should be read an arbitrary number of times, until a user-provided boolean expression is true.

 o REPEAT_UNTIL_EOB
 public static final byte REPEAT_UNTIL_EOB
Indicates that the schema item should be read an arbitrary number of times, until the end of the current block is reached.

 o REPEAT_UNTIL_EOF
 public static final byte REPEAT_UNTIL_EOF
Indicates that the schema item should be read an arbitrary number of times, until the end of the input stream is reached.

 o REPEAT_TEST_UNSPECIFIED
 public static final String REPEAT_TEST_UNSPECIFIED
Indicates an unspecified value for the repeat test for this schema item.

Methods

 o getRepeatTest
 public abstract String getRepeatTest()
Gets the repeat test for this schema item. The repeat test specifies conditions for reading a schema item more than once, when certain values are set for the repeat type.

If the repeat type value is REPEAT_N_TIMES, the repeat test must be a valid Java numeric expression. It may use constants, or numeric values of other schema items.

If the repeat type value is REPEAT_WHILE_X or REPEAT_UNTIL_X, the repeat test must be a valid Java boolean expression. It may use constants, or boolean values of other schema items.

If the repeat type value is any other value, the repeat test is ignored.

Returns:
The repeat test for this schema item.
 o getRepeatType
 public abstract byte getRepeatType()
Gets the repeat type for this schema item. The repeat type determines whether an instance is to be read once, read a fixed number of times, or read while a boolean condition is met.

Returns:
The repeat type for this schema item.
 o setRepeatTest
 public abstract void setRepeatTest(String newTest)
Sets the repeat test for this schema item.

Parameters:
newTest - The new repeat test for this schema item.
 o setRepeatType
 public abstract void setRepeatType(byte newType)
Sets the repeat type for this schema item.

Parameters:
newType - The new repeat type for this schema item.

All Packages  Class Hierarchy  This Package  Previous  Next  Index