com.heirloomcomputing.epli.runtime

Class PLIStream

java.lang.Object

com.heirloomcomputing.epli.runtime.PLIStream

All Implemented Interfaces:

IPLIFile

public class PLIStream
extends java.lang.Object
implements IPLIFile

PLIStream encapsulates all the calls to the Elastic PL/I runtime library necessary to open/close INPUT STREAM, OUTPUT STREAM and PRINT STREAM files and returns the Java classes for them to be used by the generated code Throws CONDITIONs for invalid use of this STREAM file type as a RECORD.

Author:

Heirloom Computing, Inc.

Nested Class Summary

Nested classes/interfaces inherited from interface com.heirloomcomputing.epli.runtime.IPLIFile

IPLIFile.Attr

Field Summary

Fields

Modifier and Type	Field and Description
static int	BYTES size in bytes if converted to a byte array hint: cannot be converted to a byte array

Fields inherited from interface com.heirloomcomputing.epli.runtime.IPLIFile

EnvAttrs

Constructor Summary

Constructors

Constructor and Description
PLIStream() Construct a PLIStream with no attributes
PLIStream(IPLIFile dclFile, java.lang.String title, java.lang.String env, int lineSize, int pageSize) construct a PLIStream from an IPIFile used to declare the PL/I FILE variable, and then overridden with non-null other attributes.
PLIStream(java.lang.String ddName, java.util.EnumSet<IPLIFile.Attr> declareFileAttributes) Construct a PLIStream of a certain FILE name and attributes
PLIStream(java.lang.String ddName, java.util.EnumSet<IPLIFile.Attr> declareFileAttributes, java.lang.String title, java.lang.String environment, int lineSize, int pageSize) Construct a PLIStream with a certain FILE name, attributes and TITLE, ENVIRONMENT, LINESIZE and PAGESIZE options from the DCL.

Method Summary

Modifier and Type	Method and Description
void	close() Close the file
boolean	delete() Delete the current record (the last record read) NOT VALID for STREAM files
boolean	delete(byte[] key) Delete the record identified by the key specified NOT VALID for STREAM files
boolean	deleteByPrimary(byte[] key) Delete the record identified by the primary /relative record key NOT VALID for STREAM files
boolean	deleteFile() Deletes the file
void	endData() Finish the GET DATA operation ..
java.lang.Object	getData(java.lang.String name, java.lang.Object intoVar) 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 specific 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 for the declared file
java.lang.String	getNextString(boolean quoted) Return the next string from the Scanner input stream
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 for the declared file
java.io.InputStream	inputStream() Return the Java InputStream associated with this PLI FILE
boolean	is(IPLIFile.Attr attr1) Help determine if a file attribute is set
boolean	isIsnt(IPLIFile.Attr attr1, IPLIFile.Attr attr2) Help determine if one of two mutually exclusive alternatives is or isn't set by checking (first) the open and then (second) declare attributes
boolean	isOpen() indicate whether the file is open
boolean	isStream() For PLIStream FILEs this always returns true
byte[]	keyto() Return the last key read as a result of a locate(), read() or readPrev()
static java.lang.String	Lines(int number) Return a String with a number of Java String.format() formatted new-line escapes (%n)
boolean	locate(byte[] key) Locate a point within a keyed file NOT VALID for STREAM files
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, append
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 NOT VALID for STREAM files
byte[]	read(byte[] key) Read a single record with a key NOT VALID for STREAM files
byte[]	readPrev() Read the previous record NOT VALID for STREAM files
boolean	rewrite(byte[] record) Rewrite the current record with the data and embedded key NOT VALID for STREAM files
boolean	rewrite(byte[] record, byte[] key) Rewrite the record given by a key with the data and embedded key NOT VALID for STREAM files
java.util.Scanner	scanner() Return the Java Scanner associated with the InputStream of this PLI FILE
static java.lang.String	Spaces(int number) Return a String with a number of spaces
java.lang.String	toString() Returns the self-defining information for the debugger
boolean	write(byte[] record) Write the file with the record NOT VALID for STREAM files
boolean	write(byte[] record, byte[] externalKey) Write the file with the record NOT VALID for STREAM files
boolean	write(byte[] record, long rrn) Write the file with the record NOT VALID for STREAM files

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BYTES

public static final int BYTES

size in bytes if converted to a byte array hint: cannot be converted to a byte array

See Also:

Constant Field Values

Constructor Detail

PLIStream

public PLIStream()

Construct a PLIStream with no attributes

PLIStream

public PLIStream(java.lang.String ddName,
                 java.util.EnumSet<IPLIFile.Attr> declareFileAttributes)

Construct a PLIStream of a certain FILE name and attributes

Parameters:

ddName - - the FILE constant or variable name, or its DD name replacement

declareFileAttributes - - the declareFileAttributes to initialize

PLIStream

public PLIStream(java.lang.String ddName,
                 java.util.EnumSet<IPLIFile.Attr> declareFileAttributes,
                 java.lang.String title,
                 java.lang.String environment,
                 int lineSize,
                 int pageSize)

Construct a PLIStream with a certain FILE name, attributes and TITLE, ENVIRONMENT, LINESIZE and PAGESIZE options from the DCL.

Parameters:

ddName - - the FILE constant or variable name, or its DD name replacement

declareFileAttributes - - the declareFileAttributes to initialize

title - - the FILE TITLE option

environment - - the FILE ENV option

lineSize - - the FILE LINESIZE option

pageSize - - the FILE PAGESIZE option

PLIStream

public PLIStream(IPLIFile dclFile,
                 java.lang.String title,
                 java.lang.String env,
                 int lineSize,
                 int pageSize)

construct a PLIStream from an IPIFile used to declare the PL/I FILE variable, and then overridden with non-null other attributes.

Parameters:

dclFile - - the IPIFile used during the declaration that is used as a basis for constructing a PLIStream with the following overrides:

title - - the FILE TITLE option

env - - the FILE ENV option

lineSize - - the FILE LINESIZE option

pageSize - - the FILE PAGESIZE option

Method Detail

Spaces

public static java.lang.String Spaces(int number)

Return a String with a number of spaces

Parameters:

number - of spaces to return

Returns:

the string of a number of spaces

Lines

public static java.lang.String Lines(int number)

Return a String with a number of Java String.format() formatted new-line escapes (%n)

Parameters:

number - of "%n"'s to return

Returns:

the string of a number of new line escapes

is

public boolean is(IPLIFile.Attr attr1)

Help determine if a file attribute is set

Parameters:

attr1 - - an attribute to check to see if it is set (cannot be null)

Returns:

true if attr1 is set, false otherwise

isIsnt

public boolean isIsnt(IPLIFile.Attr attr1,
                      IPLIFile.Attr attr2)

Help determine if one of two mutually exclusive alternatives is or isn't set by checking (first) the open and then (second) declare attributes

Parameters:

attr1 - - an attribute to check to see if it is set (cannot be null)

attr2 - - an attribute to check to see if it isn't set (cannot be null)

Returns:

true if attr1 is set or if attr2 is not set, false otherwise

isStream

public boolean isStream()

For PLIStream FILEs this always returns true

Specified by:

isStream in interface IPLIFile

Returns:

true

toString

public java.lang.String toString()

Returns the self-defining information for the debugger

Overrides:

toString in class java.lang.Object

Returns:

string short description

printStream

public java.io.PrintStream printStream()

Return the Java PrintStream associated with this PLI FILE

Specified by:

printStream in interface IPLIFile

Returns:

a PrintStream for those files declared or opened with PRINT STREAM

Throws:

{@link - Condition#CONDITION} UNDEFINEDFILE} for files not opened, or cannot be converted, to PRINT STREAM

inputStream

public java.io.InputStream inputStream()

Return the Java InputStream associated with this PLI FILE

Specified by:

inputStream in interface IPLIFile

Returns:

an InputStream for those files declared or opened with INPUT STREAM

Throws:

{@link - Condition#CONDITION} UNDEFINEDFILE} for files not opened, or cannot be converted, to INPUT STREAM

outputStream

public java.io.OutputStream outputStream()

Return the Java OutputStream associated with this PLI FILE

Specified by:

outputStream in interface IPLIFile

Returns:

an OutputStream for those files declared or opened with OUTPUT/UPDATE STREAM

Throws:

{@link - Condition#CONDITION} UNDEFINEDFILE} for files not opened, or cannot be converted, to PRINT STREAM

scanner

public java.util.Scanner scanner()

Return the Java Scanner associated with the InputStream of this PLI FILE

Specified by:

scanner in interface IPLIFile

Returns:

an Scanner for those files declared or opened with INPUT STREAM

Throws:

{@link - Condition#CONDITION} UNDEFINEDFILE} for files not opened, or cannot be converted, to INPUT STREAM

getNextString

public java.lang.String getNextString(boolean quoted)

Return the next string from the Scanner input stream

Parameters:

quoted - - if the string to be returned will be quoted

Returns:

the next token in the Scanner input stream

getData

public java.lang.Object getData(java.lang.String name,
                                java.lang.Object intoVar)

Perform a GET DATA operation (name=value variable retrieval) from an input stream

Specified by:

getData in interface IPLIFile

Parameters:

name - - the name or partial name (i.e., part of a Group structure)

intoVar - - the variable to retrieve data into (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

public void endData()

Finish the GET DATA operation .. skip remaining input until ';' terminator (not until end-of-line)

Specified by:

endData in interface IPLIFile

getDDName

public 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 specific with the TITLE attribute

Specified by:

getDDName in interface IPLIFile

Returns:

the DD name

getEnvironment

public java.lang.String getEnvironment()

Return the current environment for the declared file

Specified by:

getEnvironment in interface IPLIFile

Returns:

the current environment settings

getTitle

public java.lang.String getTitle()

Return the current title for the declared file

Specified by:

getTitle in interface IPLIFile

Returns:

the current title settings

getDSName

public 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. note: we treat the rules of properties and environment variables in a similar fashion, see p. 204 in the IBM Ent PL/I 5.1 Prog Guide

Specified by:

getDSName in interface IPLIFile

Returns:

the dataset name associated with this FILE

getDeclareFileAttributes

public java.util.EnumSet<IPLIFile.Attr> getDeclareFileAttributes()

Return the the set of file attributes used on the DCL

Specified by:

getDeclareFileAttributes in interface IPLIFile

Returns:

the EnumSet declareFileAttributes

getOpenFileAttributes

public java.util.EnumSet<IPLIFile.Attr> getOpenFileAttributes()

Return the the set of file attributes used on the OPEN FILE

Specified by:

getOpenFileAttributes in interface IPLIFile

Returns:

the EnumSet openFileAttributes

open

public 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, append

Specified by:

open in interface IPLIFile

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

isOpen

public boolean isOpen()

indicate whether the file is open

Specified by:

isOpen in interface IPLIFile

Returns:

true if this file is currently open

close

public void close()

Close the file

Specified by:

close in interface IPLIFile

deleteFile

public boolean deleteFile()

Deletes the file

Specified by:

deleteFile in interface IPLIFile

Returns:

true if deleted, false if not found or could not be deleted

Throws:

Condition.CONDITION.UNDEFINEDFILE - if the file could not be deleted

locate

public boolean locate(byte[] key)

Locate a point within a keyed file NOT VALID for STREAM files

Specified by:

locate in interface IPLIFile

Parameters:

key - the bytearray key to read

Returns:

null if no record found or the byte array of the record

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

keyto

public byte[] keyto()

Return the last key read as a result of a locate(), read() or readPrev()

Specified by:

keyto in interface IPLIFile

Returns:

null if no record found or the byte array of the key

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

read

public byte[] read(byte[] key)

Read a single record with a key NOT VALID for STREAM files

Specified by:

read in interface IPLIFile

Parameters:

key - the bytearray key to read

Returns:

null if no record found or the byte array of the record

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

read

public byte[] read()

Read the next record NOT VALID for STREAM files

Specified by:

read in interface IPLIFile

Returns:

null if end of file or the byte array of the record

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

readPrev

public byte[] readPrev()

Read the previous record NOT VALID for STREAM files

Specified by:

readPrev in interface IPLIFile

Returns:

null if end of file or the byte array of the record

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

write

public boolean write(byte[] record,
                     long rrn)

Write the file with the record NOT VALID for STREAM files

Specified by:

write in interface IPLIFile

Parameters:

record - bytearray of the record

rrn - the relative record number of a RELATIVE FILE

Returns:

true if worked, false otherwise (getStatus() available)

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

write

public boolean write(byte[] record)

Write the file with the record NOT VALID for STREAM files

Specified by:

write in interface IPLIFile

Parameters:

record - bytearray of the record

Returns:

true if worked

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

write

public boolean write(byte[] record,
                     byte[] externalKey)

Write the file with the record NOT VALID for STREAM files

Specified by:

write in interface IPLIFile

Parameters:

record - bytearray of the record

externalKey - if external to record being written

Returns:

true if worked

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

rewrite

public boolean rewrite(byte[] record)

Rewrite the current record with the data and embedded key NOT VALID for STREAM files

Specified by:

rewrite in interface IPLIFile

Parameters:

record - new bytearray of the record

Returns:

true if worked, false otherwise (getStatus() available)

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

rewrite

public boolean rewrite(byte[] record,
                       byte[] key)

Rewrite the record given by a key with the data and embedded key NOT VALID for STREAM files

Specified by:

rewrite in interface IPLIFile

Parameters:

record - new bytearray of the record

Returns:

true if worked, false otherwise (getStatus() available)

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

deleteByPrimary

public boolean deleteByPrimary(byte[] key)

Delete the record identified by the primary /relative record key NOT VALID for STREAM files

Specified by:

deleteByPrimary in interface IPLIFile

Parameters:

key - the key of the record to delete

Returns:

true if worked, false otherwise (getStatus() available)

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

delete

public boolean delete(byte[] key)

Delete the record identified by the key specified NOT VALID for STREAM files

Specified by:

delete in interface IPLIFile

Returns:

true if worked, false otherwise (getStatus() available)

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally

delete

public boolean delete()

Delete the current record (the last record read) NOT VALID for STREAM files

Specified by:

delete in interface IPLIFile

Returns:

true if worked, false otherwise (getStatus() available)

Throws:

Condition.CONDITION.UNDEFINEDFILE - unconditionally