All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.beans.tools.dataFormatWizard.SchemaItem
java.lang.Object
|
+----com.ibm.beans.tools.dataFormatWizard.SchemaItem
- public abstract class SchemaItem
- extends Object
- implements PropertyChangeAnnouncer, Serializable, Transferable
The SchemaItem class is an abstract superclass for objects that
comprise a file schema.
-
EMITTED_READ_LEGACY_STREAM_NAME
- The default name for data stream variables in emitted reader code.
-
SchemaItem()
-
-
addPropertyChangeListener(PropertyChangeListener)
- Adds a PropertyChangeListener object to the listener list.
-
emitDeclaration(PrintWriter)
- Emits source code to declare storage for the field or record data
represented by this schema item.
-
emitGetterMethod(PrintWriter)
- Emits source code to get the field or record data represented
by this schema item.
-
emitReadLegacyCode(PrintWriter, String)
- Emits source code to read the field or record data represented
by this schema item.
-
firePropertyChange(String, Object, Object)
- Reports a bound property update to any registered listeners.
-
getAttributesAsText()
- Gets a String representing the attributes of this schema item.
-
getParentItem()
- Gets the parent item for this schema item.
-
getTransferData(DataFlavor)
- Returns an object that represents the data to be transferred.
-
getTransferDataFlavors()
- Returns an array of DataFlavor objects indicating the flavors in
which the data can be provided.
-
getView()
- Gets a graphical user interface component for displaying this
schema item.
-
hasAttribute(Class)
- Reports whether this schema item supports a given attribute interface.
-
insertNewItem(SchemaItem)
- Inserts a new item into the schema:
- If this item is capable of containing sub-items, the new item
should be inserted at the end of the sub-item collection.
- If this item is not capable of containing sub-items, the new
item should be inserted into the sub-item collection of the
parent for this item, in the position immediately following
this item.
-
isDataFlavorSupported(DataFlavor)
- Reports whether the specified data flavor is supported for this object.
-
isSchemaItem(Object)
- Reports whether a given object is a subclass of of a given class.
-
newItemFromString(String)
- Converts a string into a schema item.
-
removeItem(SchemaItem)
- Removes an item from the schema.
-
removePropertyChangeListener(PropertyChangeListener)
- Removes a PropertyChangeListener object from the listener list.
-
setParentItem(SchemaItem)
- Sets the new parent item for this schema item.
EMITTED_READ_LEGACY_STREAM_NAME
public static final String EMITTED_READ_LEGACY_STREAM_NAME
- The default name for data stream variables in emitted reader code.
SchemaItem
public SchemaItem()
getParentItem
public SchemaItem getParentItem()
- Gets the parent item for this schema item.
- Returns:
- The parent item for this schema item.
setParentItem
public void setParentItem(SchemaItem newParent)
- Sets the new parent item for this schema item.
- Parameters:
- newParent - The new parent item for this schema item.
getAttributesAsText
public abstract String getAttributesAsText()
- Gets a String representing the attributes of this schema item.
- Returns:
- A String representing the attributes of this schema item.
isSchemaItem
public static boolean isSchemaItem(Object candidate)
- Reports whether a given object is a subclass of of a given class.
- Returns:
- true if the object is a subclass of the given
class; false otherwise.
newItemFromString
public static SchemaItem newItemFromString(String string)
- Converts a string into a schema item.
- Parameters:
- string - A string containing the serialized data for
a schema item.
- Returns:
- The schema item serialized within the string; or null
if the string does not contain a valid serialized item.
insertNewItem
public abstract void insertNewItem(SchemaItem newItem)
- Inserts a new item into the schema:
- If this item is capable of containing sub-items, the new item
should be inserted at the end of the sub-item collection.
- If this item is not capable of containing sub-items, the new
item should be inserted into the sub-item collection of the
parent for this item, in the position immediately following
this item.
- Parameters:
- newItem - The new item to be added to the schema.
removeItem
public abstract void removeItem(SchemaItem item)
- Removes an item from the schema.
- Parameters:
- item - The item to be removed from the schema.
emitDeclaration
public abstract 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.
emitGetterMethod
public abstract 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.
emitReadLegacyCode
public abstract 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.
getView
public abstract ViewForItem getView()
- Gets a graphical user interface component for displaying this
schema item.
- Returns:
- A view component for displaying this schema item.
hasAttribute
public abstract boolean hasAttribute(Class attributeClass)
- Reports whether this schema item supports a given attribute interface.
- Returns:
- true if the schema item supports the attribute
interface; false otherwise.
addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)
- Adds a PropertyChangeListener object to the listener list.
- Parameters:
- listener - The listener to be added.
removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)
- Removes a PropertyChangeListener object from the listener list.
- Parameters:
- listener - The listener object to be removed.
firePropertyChange
public void firePropertyChange(String propertyName,
Object oldValue,
Object newValue)
- Reports a bound property update to any registered listeners. No event
should be fired if the old and new values are are equal and non-null.
- Parameters:
- propertyName - The name of the property that was changed.
- oldValue - The old value of the property.
- newValue - The new value of the property.
getTransferDataFlavors
public DataFlavor[] getTransferDataFlavors()
- Returns an array of DataFlavor objects indicating the flavors in
which the data can be provided. The array should be ordered according
to preference for providing the data (from most richly descriptive to
least descriptive).
- Returns:
- An array of data flavors in which this data can
be transferred.
isDataFlavorSupported
public boolean isDataFlavorSupported(DataFlavor flavor)
- Reports whether the specified data flavor is supported for this object.
- Parameters:
- flavor - The requested flavor for the data.
- Returns:
- true if the specified data flavor is supported;
false otherwise.
getTransferData
public Object getTransferData(DataFlavor flavor) throws UnsupportedFlavorException, IOException
- Returns an object that represents the data to be transferred.
The class of the object returned is defined by the representation
class of the flavor.
- Parameters:
- flavor - The requested flavor for the data.
- Returns:
- An object that represents the data to be transferred.
- Throws: IOException
- Thrown if the data is no longer available in the requested flavor.
- Throws: UnsupportedFlavorException
- Thrown if the requested data flavor is not supported.
All Packages Class Hierarchy This Package Previous Next Index