All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.beans.tools.dataFormatWizard.SchemaPrimitiveField

java.lang.Object
   |
   +----com.ibm.beans.tools.dataFormatWizard.SchemaItem
           |
           +----com.ibm.beans.tools.dataFormatWizard.SchemaField
                   |
                   +----com.ibm.beans.tools.dataFormatWizard.SchemaPrimitiveField

public class SchemaPrimitiveField
extends SchemaField
implements PrimitiveTypeAttribute, DiscardAttribute, NameAttribute, RepeatAttribute
The SchemaPrimitiveField represents a field expected at a given point within a file schema, which can be represented as a Java primitive type. It contains a type field, used to indicate which Java primitive type can contain the field value when reading, writing, or storing the stream.

See Also:
SchemaItem, PrimitiveTypeAttribute, DiscardAttribute, NameAttribute, RepeatAttribute

Constructor Index

 o SchemaPrimitiveField()
Creates a new SchemaPrimitiveField instance.

Method Index

 o emitDeclaration(PrintWriter)
Emits source code to declare storage for the field or record data represented by this schema item.
 o emitGetterMethod(PrintWriter)
Emits source code to get the field or record data represented by this schema item.
 o emitReadLegacyCode(PrintWriter, String)
Emits source code to read the field or record data represented by this schema item.
 o getAttributesAsText()
Gets a String representing the attributes of this primitive field.
 o getName()
Returns the name of this schema.
 o getPrimitiveType()
Gets the primitive type for this schema field.
 o getRepeatTest()
Gets the repeat test for this schema item.
 o getRepeatType()
Gets the repeat type for this schema item.
 o getView()
Gets a graphical user interface component for displaying this schema item.
 o hasAttribute(Class)
Reports whether this field supports a given attribute interface.
 o isDiscardable()
Reports whether this schema item is discardable.
 o setDiscardable(boolean)
Controls whether this schema item is discardable.
 o setName(String)
Sets the new name of this schema item.
 o setPrimitiveType(String)
Sets the primitive type for this schema field.
 o setRepeatTest(String)
Sets the repeat test for this schema item.
 o setRepeatType(byte)
Sets the repeat type for this schema item.

Constructors

 o SchemaPrimitiveField
 public SchemaPrimitiveField()
Creates a new SchemaPrimitiveField instance.

Methods

 o emitDeclaration
 public void emitDeclaration(PrintWriter sourceCodeStream)
Emits source code to declare storage for the field or record data represented by this schema item.

Parameters:
sourceCodeStream - The source code output stream.
Overrides:
emitDeclaration in class SchemaItem
 o emitGetterMethod
 public void emitGetterMethod(PrintWriter sourceCodeStream)
Emits source code to get the field or record data represented by this schema item.

Parameters:
sourceCodeStream - The source code output stream.
Overrides:
emitGetterMethod in class SchemaItem
 o emitReadLegacyCode
 public void emitReadLegacyCode(PrintWriter sourceCodeStream,
                                String inputStreamName)
Emits source code to read the field or record data represented by this schema item.

Parameters:
sourceCodeStream - The source code output stream.
inputStreamName - The input stream name to be used by the emitted code.
Overrides:
emitReadLegacyCode in class SchemaItem
 o getView
 public ViewForItem getView()
Gets a graphical user interface component for displaying this schema item.

Returns:
A view component for displaying this schema item.
Overrides:
getView in class SchemaItem
 o getAttributesAsText
 public String getAttributesAsText()
Gets a String representing the attributes of this primitive field.

Returns:
A String representing the attributes of this primitive field.
Overrides:
getAttributesAsText in class SchemaItem
 o hasAttribute
 public boolean hasAttribute(Class attributeClass)
Reports whether this field supports a given attribute interface.

Returns:
true if the field supports the attribute interface; false otherwise.
Overrides:
hasAttribute in class SchemaItem
 o getPrimitiveType
 public String getPrimitiveType()
Gets the primitive type for this schema field.

Returns:
A string representing the primitive type for this schema field.
See Also:
PrimitiveTypeAttribute
 o setPrimitiveType
 public void setPrimitiveType(String newType) throws IllegalArgumentException
Sets the primitive type for this schema field.

Parameters:
newType - The new primitive type of this schema field.
Throws: IllegalArgumentException
Thrown if the new type is not one of the predefined values defined in the PrimitiveTypeAttribute interface.
See Also:
PrimitiveTypeAttribute
 o isDiscardable
 public boolean isDiscardable()
Reports whether this schema item is discardable.

Returns:
true if this schema item is discardable; false otherwise.
See Also:
DiscardAttribute
 o setDiscardable
 public void setDiscardable(boolean newState)
Controls whether this schema item is discardable.

Parameters:
newState - The new discardability status for this schema item.
See Also:
DiscardAttribute
 o getName
 public String getName()
Returns the name of this schema.

Returns:
A string containing the name of this schema item.
See Also:
NameAttribute
 o setName
 public void setName(String newName)
Sets the new name of this schema item.

Parameters:
newName - The new name for this schema item.
See Also:
NameAttribute
 o getRepeatTest
 public String getRepeatTest()
Gets the repeat test for this schema item. The repeat test is a boolean or numeric expression to control how many times this item is repeated.

Returns:
A string containing the repeat test for this schema item.
See Also:
RepeatAttribute
 o getRepeatType
 public byte getRepeatType()
Gets the repeat type for this schema item.

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

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

Parameters:
newType - The new repeat type for this schema item.
Throws: IllegalArgumentException
Thrown if the new repeat type is not one of the legal values for a repeat type, as defined by interface RepeatAttribute.
See Also:
RepeatAttribute

All Packages  Class Hierarchy  This Package  Previous  Next  Index