com.ibm.as400.access

Class SequentialFile

  • All Implemented Interfaces:
    java.io.Serializable


    public class SequentialFile
    extends AS400File
    implements java.io.Serializable
    The SequentialFile class represents a physical or logical file on the system. The SequentialFile class allows the user to do the following:
    • Create a physical file by:
      • Specifying a record length.
      • Specifying an existing DDS source file.
      • Specifying a RecordFormat object that contains a description of the record format for the file.
    • Access the records in a file sequentially or by record number. Note: To read a keyed physical or logical file sequentially and have the records returned in key order, use the read...() methods of KeyedFile.
    • Write records to a file sequentially.
    • Update records in a file sequentially or by record number.
    • Lock a file for different types of access.
    • Use commitment control when accessing a file. The user can:
      • Start commitment control for the connection.
      • Specify different commitment control lock levels for the individual files being accessed.
      • Commit and rollback transactions for the connection.
    • Delete a physical or logical file or member.
    SequentialFile objects generate the following events:
    • FileEvent
      The events fired are:
      • FILE_CLOSED
      • FILE_CREATED
      • FILE_DELETED
      • FILE_MODIFIED
      • FILE_OPENED
    • PropertyChangeEvent
    • VetoableChangeEvent
    See Also:
    MemberList, Serialized Form
    • Constructor Detail

      • SequentialFile

        public SequentialFile()
        Constructs a SequentialFile object.
      • SequentialFile

        public SequentialFile(AS400 system,
                      java.lang.String name)
        Constructs a SequentialFile object. It uses the system and file name specified. If the name for the file does not include a member, the first member of the file will be used.
        Parameters:
        system - The system to which to connect. The system cannot be null.
        name - The integrated file system pathname of the file. The name cannot be null.
    >
    • Method Detail

      • deleteRecord

        public void deleteRecord(int recordNumber)
                          throws AS400Exception,
                                 AS400SecurityException,
                                 java.lang.InterruptedException,
                                 java.io.IOException
        Deletes the record specified by record number. The file must be open when invoking this method.
        Parameters:
        recordNumber - The record number of the record to be deleted.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
      • positionCursor

        public void positionCursor(int recordNumber)
                            throws AS400Exception,
                                   AS400SecurityException,
                                   java.lang.InterruptedException,
                                   java.io.IOException
        Positions the file cursor to the first record whose record number matches the specified record number. The file must be open when invoking this method.
        Parameters:
        recordNumber - The record number of the record at which to position the cursor.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
      • positionCursorAfter

        public void positionCursorAfter(int recordNumber)
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        java.lang.InterruptedException,
                                        java.io.IOException
        Positions the file cursor to the first record after the record specified by the record number. The file must be open when invoking this method.
        Parameters:
        recordNumber - The record number of the record after which to position the cursor. The recordNumber must be greater than zero.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
      • positionCursorBefore

        public void positionCursorBefore(int recordNumber)
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         java.lang.InterruptedException,
                                         java.io.IOException
        Positions the file cursor to the first record before the record specified by the record number. The file must be open when invoking this method.
        Parameters:
        recordNumber - The record number of the record before which to position the cursor. The recordNumber must be greater than zero.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
      • read

        public Record read(int recordNumber)
                    throws AS400Exception,
                           AS400SecurityException,
                           java.lang.InterruptedException,
                           java.io.IOException
        Reads the record with the specified record number. The file must be open when invoking this method.
        Parameters:
        recordNumber - The record number of the record to be read. The recordNumber must be greater than zero.
        Returns:
        The record read. If the record is not found, null is returned.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
      • readAfter

        public Record readAfter(int recordNumber)
                         throws AS400Exception,
                                AS400SecurityException,
                                java.lang.InterruptedException,
                                java.io.IOException
        Reads the first record after the record with the specified record number. The file must be open when invoking this method.
        Parameters:
        recordNumber - record number of the record prior to the record to be read. The recordNumber must be greater than zero.
        Returns:
        The record read. If the record is not found, null is returned.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
      • readAll

        public Record[] readAll()
                         throws AS400Exception,
                                AS400SecurityException,
                                java.lang.InterruptedException,
                                java.io.IOException
        Reads all the records in the file. The file must be closed when invoking this method. The record format for the file must have been set prior to invoking this method.
        Specified by:
        readAll in class AS400File
        Returns:
        The records read. If no records are read, an array of size zero is returned.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
        ServerStartupException - If the host server cannot be started.
        java.net.UnknownHostException - If the system cannot be located.
      • readBefore

        public Record readBefore(int recordNumber)
                          throws AS400Exception,
                                 AS400SecurityException,
                                 java.lang.InterruptedException,
                                 java.io.IOException
        Reads the first record before the record with the specified record number. The file must be open when invoking this method.
        Parameters:
        recordNumber - The record number of the record after the record to be read. The recordNumber must be greater than zero.
        Returns:
        The record read. If the record is not found, null is returned.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.
      • update

        public void update(int recordNumber,
                  Record record)
                    throws AS400Exception,
                           AS400SecurityException,
                           java.lang.InterruptedException,
                           java.io.IOException
        Updates the record at the position specified by the record number. The file must be open when invoking this method.
        Parameters:
        recordNumber - The record number of the record to update. The recordNumber must be greater than zero.
        record - The record with which to update.
        Throws:
        AS400Exception - If the system returns an error message.
        AS400SecurityException - If a security or authority error occurs.
        ConnectionDroppedException - If the connection is dropped unexpectedly.
        java.lang.InterruptedException - If this thread is interrupted.
        java.io.IOException - If an error occurs while communicating with the system.