com.ibm.broker.plugin

Class MbTable

  • java.lang.Object
    • com.ibm.broker.plugin.MbTable


  • public class MbTable
    extends java.lang.Object
    MbTable is a complex data type which contains one or more rows of simple data types. It structure is very similar to a * standard java record set. It can not be constructed in a node but instead is returned by the getUserDefinedAttribute() on the MbNode class. Its primary use is in allowing complex attributes to be defined on nodes instead of the normal static simple types. It can only be used in the runtime if a version of the toolkit that supports complex properties is being used.
    • Constructor Summary

      Constructors 
      Constructor and Description
      MbTable(MbProperty property)
      Constructs an MbTable object from an MbProperty so that the MbTable object can be used to navigate the propery if it is complex
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean first()
      Moves the cursor to the first row.
      java.lang.Object getValue(java.lang.String name)
      Returns a java object representing the data in the named column on the current row.
      boolean isFirst()
      Checks whether the cursor is pointing to the first row.
      boolean isLast()
      Checks whether the cursor is pointing to the last row.
      boolean last()
      Moves the cursor to the last row.
      boolean lastMove()
      Returns the state of the last move.
      boolean moveToRow(int row)
      Moves the cursor to the row given by the 'row' parameter (first row is index zero).
      boolean next()
      Moves the cursor to the next row.
      boolean previous()
      Moves the cursor to the previous row.
      int size()
      Returns the number of rows in the table.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MbTable

        public MbTable(MbProperty property)
        Constructs an MbTable object from an MbProperty so that the MbTable object can be used to navigate the propery if it is complex
        Parameters:
        property - An MbProperty such as a node property
    • Method Detail

      • moveToRow

        public boolean moveToRow(int row)
        Moves the cursor to the row given by the 'row' parameter (first row is index zero). If the move fails then the cursor stays unmoved.
        Parameters:
        row - The row to move to in the table.
        Returns:
        true if the move was successful
      • isFirst

        public boolean isFirst()
        Checks whether the cursor is pointing to the first row.
        Returns:
        true if the move was successful
      • first

        public boolean first()
        Moves the cursor to the first row. If the move fails then the cursor stays unmoved.
        Returns:
        true if the move was sucessful.
      • isLast

        public boolean isLast()
        Checks whether the cursor is pointing to the last row.
        Returns:
        true if the cursor points to the last row.
      • last

        public boolean last()
        Moves the cursor to the last row. If the move fails then the cursor stays unmoved.
        Returns:
        true if the move was successful
      • next

        public boolean next()
        Moves the cursor to the next row. If the move fails then the cursor stays unmoved.
        Returns:
        true if the move was successful
      • previous

        public boolean previous()
        Moves the cursor to the previous row. If the move fails then the cursor stays unmoved.
        Returns:
        true if the move was successful
      • lastMove

        public boolean lastMove()
        Returns the state of the last move.
        Returns:
        true if the last move was successful
      • size

        public int size()
        Returns the number of rows in the table.
        Returns:
        number of rows in table
      • getValue

        public java.lang.Object getValue(java.lang.String name)
        Returns a java object representing the data in the named column on the current row. If the name is unknown then null is returned. The Object will be one of the following supported data types:
        • MbDate
        • MbTime
        • MbTimestamp
        • Boolean
        • byte[]
        • String
        • Integer
        • Double
        • Float
        • BitSet
        Returns:
        Object representing the data held in the column
IBM Integration BusTM
JavaTM Plugin Node API