IPLIFile

All Known Implementing Classes:

PLIRecord, PLIStream
```
public interface IPLIFile
```
IPLIFile is the interface supported by two Elastic PL/I classes that encapsulate Elastic PL/I file operations ... record I/O (PLIRecord) and stream I/O (PLIStream) as well as the factory (PLIFile) that constructs one or the other.

Author:

Heirloom Computing, Inc.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IPLIFile.Attr
Keep track of a set of PL/I FILE attributes.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IPLIFile.Attr` Keep track of a set of PL/I FILE attributes.

Field Summary

Fields
Modifier and Type Field and Description

static java.util.EnumSet<IPLIFile.Attr> EnvAttrs
set of Attrs that are valid in FILE ENVIRONMENT clause

Fields
Modifier and Type	Field and Description
`static java.util.EnumSet<IPLIFile.Attr>`	`EnvAttrs` set of Attrs that are valid in FILE ENVIRONMENT clause

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Close the file
`boolean`	`delete()` Delete the current record (the last record read)
`boolean`	`delete(byte[] key)` Delete the record identified by the key specified when this file or index was opened, which could be a primary or alternate key (IDX files).
`boolean`	`deleteByPrimary(byte[] key)` Delete the record identified by the primary /relative record key passed in as a byte array
`boolean`	`deleteFile()` Deletes the file
`void`	`endData()` Finish the GET DATA operation
`java.lang.Object`	`getData(java.lang.String name, java.lang.Object var)` Perform a GET DATA operation (name=value variable retrieval) from an input stream
`java.lang.String`	`getDDName()` Return the DD name for this FILE, which is either the FILE variable or constant name or an alternate to it specifiec with the TITLE attribute
`java.util.EnumSet<IPLIFile.Attr>`	`getDeclareFileAttributes()` Return the the set of file attributes used on the DCL
`java.lang.String`	`getDSName()` Return the dataset name for this FILE which has been passed as part of the TITLE attribute or associated with the system property or environment variable associated with its DD name
`java.lang.String`	`getEnvironment()` Return the current environment settings defined for this file
`java.util.EnumSet<IPLIFile.Attr>`	`getOpenFileAttributes()` Return the the set of file attributes used on the OPEN FILE
`java.lang.String`	`getTitle()` Return the current title settings defined for this file
`java.io.InputStream`	`inputStream()` inputStream - return the Java InputStream associated with this PLI FILE
`boolean`	`isOpen()` indicate whether this file is open
`boolean`	`isStream()` Return true if the file is opened with attribute STREAM, false if otherwise
`byte[]`	`keyto()` Return the last key read as a result of a locate(), read() or readPrev()
`boolean`	`locate(byte[] key)` Locate a point within a keyed file, allowing subsequent read()s from that point forward
`boolean`	`open(java.util.EnumSet<IPLIFile.Attr> mode, java.lang.String title, java.lang.String environment, int lineSize, int pageSize)` Opens the file for read, write, both, extend
`java.io.OutputStream`	`outputStream()` Return the Java OutputStream associated with this PLI FILE
`java.io.PrintStream`	`printStream()` Return the Java PrintStream associated with this PLI FILE
`byte[]`	`read()` Read the next record (only if opened not-random)
`byte[]`	`read(byte[] key)` Read a single record with a key
`byte[]`	`readPrev()` Read the previous record (only if opened not-random)
`boolean`	`rewrite(byte[] record)` Rewrite the current record with the data and embedded key
`boolean`	`rewrite(byte[] record, byte[] key)` Rewrite the record given by a key with the data and embedded key
`java.util.Scanner`	`scanner()` Return the Java Scanner associated with the InputStream within this PLI FILE
`boolean`	`write(byte[] record)`
`boolean`	`write(byte[] record, byte[] externalKey)`
`boolean`	`write(byte[] record, long rrn)` Write the file with the record and specific relative record number

- Field Detail
  - EnvAttrs
```
static final java.util.EnumSet<IPLIFile.Attr> EnvAttrs
```
    set of Attrs that are valid in FILE ENVIRONMENT clause
- Method Detail
  - isStream
```
boolean isStream()
```
    Return true if the file is opened with attribute STREAM, false if otherwise
    
    Returns:
    
    true if STREAM
  - printStream
```
java.io.PrintStream printStream()
```
    Return the Java PrintStream associated with this PLI FILE
    
    Returns:
    
    an PrintStream for those files declared or opened with OUTPUT/UPDATE STREAM
    
    Throws:
    
    CONDITION(UNDEFINEDFILE) - for files not opened, or cannot be converted, to INPUT STREAM
  - inputStream
```
java.io.InputStream inputStream()
```
    inputStream - return the Java InputStream associated with this PLI FILE
    
    Returns:
    
    an InputStream for those files declared or opened with INPUT STREAM
    
    Throws:
    
    CONDITION(UNDEFINEDFILE) - for files not opened, or cannot be converted, to PRINT STREAM
  - scanner
```
java.util.Scanner scanner()
```
    Return the Java Scanner associated with the InputStream within this PLI FILE
    
    Returns:
    
    an InputStream for those files declared or opened with INPUT STREAM
    
    Throws:
    
    CONDITION(UNDEFINEDFILE) - for files not opened, or cannot be converted, to PRINT STREAM
  - outputStream
```
java.io.OutputStream outputStream()
```
    Return the Java OutputStream associated with this PLI FILE
    
    Returns:
    
    a OutputStream for those files declared or opened with OUTPUT STREAM
    
    Throws:
    
    CONDITION(UNDEFINEDFILE) - for files not opened, or cannot be converted, to PRINT STREAM
  - getData
```
java.lang.Object getData(java.lang.String name,
                         java.lang.Object var)
```
    Perform a GET DATA operation (name=value variable retrieval) from an input stream
    
    Parameters:
    
    name - - the name or partial name (i.e., part of a Group structure)
    
    var - - the variable to retrieve (Array, Group, Integer, etc.)
    
    Returns:
    
    either null if the var can be modified directly (i.e., is not immutable; e.g, it is a Group, Array or FixedBin) or a new object of the same type as var (i.e., var is immutable and cannot be changed)
  - endData
```
void endData()
```
    Finish the GET DATA operation
  - getDDName
```
java.lang.String getDDName()
```
    Return the DD name for this FILE, which is either the FILE variable or constant name or an alternate to it specifiec with the TITLE attribute
    
    Returns:
    
    the DD name
  - getDSName
```
java.lang.String getDSName()
```
    Return the dataset name for this FILE which has been passed as part of the TITLE attribute or associated with the system property or environment variable associated with its DD name
    
    Returns:
    
    the DS name
  - getEnvironment
```
java.lang.String getEnvironment()
```
    Return the current environment settings defined for this file
    
    Returns:
    
    the environment
  - getTitle
```
java.lang.String getTitle()
```
    Return the current title settings defined for this file
    
    Returns:
    
    the environment
  - getDeclareFileAttributes
```
java.util.EnumSet<IPLIFile.Attr> getDeclareFileAttributes()
```
    Return the the set of file attributes used on the DCL
    
    Returns:
    
    the EnumSet declareFileAttributes
  - getOpenFileAttributes
```
java.util.EnumSet<IPLIFile.Attr> getOpenFileAttributes()
```
    Return the the set of file attributes used on the OPEN FILE
    
    Returns:
    
    the EnumSet openFileAttributes
  - open
```
boolean open(java.util.EnumSet<IPLIFile.Attr> mode,
             java.lang.String title,
             java.lang.String environment,
             int lineSize,
             int pageSize)
```
    Opens the file for read, write, both, extend
    
    Parameters:
    
    mode - an EnumSet of Attrs
    
    title - - the TITLE attribute or null
    
    environment - - the ENVIRONMENT attribute or null
    
    lineSize - - the LINESIZE attribute or 0
    
    pageSize - - the PAGESIZE attribute or 0 read sequential disregarding key order; null to read sequentially in orderbykey() key order
    
    Returns:
    
    true if opened, false if not and the raising of CONDITIONs has been suppressed
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if an error occurred during open
  - locate
```
boolean locate(byte[] key)
```
    Locate a point within a keyed file, allowing subsequent read()s from that point forward
    
    Parameters:
    
    key - the bytearray key to read
    
    Returns:
    
    false if no record found or the byte array of the record
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored
  - read
```
byte[] read(byte[] key)
```
    Read a single record with a key
    
    Parameters:
    
    key - the bytearray key to read
    
    Returns:
    
    null if no record found or the byte array of the record
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ENDFILE if there are no more records to read, Condition.CONDITION.ERROR if a prior condition was ignored
  - read
```
byte[] read()
```
    Read the next record (only if opened not-random)
    
    Returns:
    
    null if end of file or the byte array of the record
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ENDFILE if there are no more records to read, Condition.CONDITION.ERROR if a prior condition was ignored
  - readPrev
```
byte[] readPrev()
```
    Read the previous record (only if opened not-random)
    
    Returns:
    
    null if end of file or the byte array of the record
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ENDFILE if there are no more records to read, Condition.CONDITION.ERROR if a prior condition was ignored
  - keyto
```
byte[] keyto()
```
    Return the last key read as a result of a locate(), read() or readPrev()
    
    Returns:
    
    null if no record found or the byte array of the key
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ENDFILE if there are no more records to read, Condition.CONDITION.ERROR if a prior condition was ignored
  - write
```
boolean write(byte[] record,
              long rrn)
```
    Write the file with the record and specific relative record number
    
    Parameters:
    
    record - bytearray of the record
    
    Returns:
    
    true if worked, false otherwise (getStatus() available)
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored
  - write
```
boolean write(byte[] record)
```
  - write
```
boolean write(byte[] record,
              byte[] externalKey)
```
  - rewrite
```
boolean rewrite(byte[] record)
```
    Rewrite the current record with the data and embedded key
    
    Parameters:
    
    record - new bytearray of the record
    
    Returns:
    
    true if worked, false otherwise (getStatus() available)
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored
  - rewrite
```
boolean rewrite(byte[] record,
                byte[] key)
```
    Rewrite the record given by a key with the data and embedded key
    
    Parameters:
    
    record - new bytearray of the record
    
    Returns:
    
    true if worked, false otherwise (getStatus() available)
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored
  - deleteByPrimary
```
boolean deleteByPrimary(byte[] key)
```
    Delete the record identified by the primary /relative record key passed in as a byte array
    
    Returns:
    
    true if worked, false otherwise (getStatus() available)
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored
  - delete
```
boolean delete(byte[] key)
```
    Delete the record identified by the key specified when this file or index was opened, which could be a primary or alternate key (IDX files). REL files its the same key.
    
    Returns:
    
    true if worked, false otherwise (getStatus() available)
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored
  - isOpen
```
boolean isOpen()
```
    indicate whether this file is open
    
    Returns:
    
    true if this file is currently open
  - delete
```
boolean delete()
```
    Delete the current record (the last record read)
    
    Returns:
    
    true if worked, false otherwise (getStatus() available)
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored
  - close
```
void close()
```
    Close the file
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored
  - deleteFile
```
boolean deleteFile()
```
    Deletes the file
    
    Returns:
    
    true if deleted, false if not found or could not be deleted
    
    Throws:
    
    Condition.CONDITION.UNDEFINEDFILE - if the file is closed, Condition.CONDITION.ERROR if a prior condition was ignored

Interface IPLIFile

Nested Class Summary

Field Summary

Method Summary

Field Detail

EnvAttrs

Method Detail

isStream

printStream

inputStream

scanner

outputStream

getData

endData

getDDName

getDSName

getEnvironment

getTitle

getDeclareFileAttributes

getOpenFileAttributes

open

locate

read

read

readPrev

keyto

write

write

write

rewrite

rewrite

deleteByPrimary

delete

isOpen

delete

close

deleteFile