com.heirloomcomputing.epli.runtime

Class PLIRecord

java.lang.Object

com.heirloomcomputing.epli.runtime.PLIRecord

All Implemented Interfaces:

IPLIFile

public class PLIRecord
extends java.lang.Object
implements IPLIFile

PLIRecord encapsulates all the calls to the Elastic PL/I runtime library necessary to manipulate ISAM or other format files. It wrappers those methods used within com.heirloomcomputing.ecs.isamsql.COBOLFile. Throws Conditions for invalid use of this RECORD file type as a STREAM.

Requires access to ecobol.jar in order to function

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
PLIRecord() PLIRecord constructor tests whether ecobol.jar is accessible
PLIRecord(IPLIFile dclFile, java.lang.String title, java.lang.String environment, int lineSize, int pageSize) construct a PLIRecord from an IPIFile used to declare the PL/I FILE variable, and then overridden with non-null other attributes.
PLIRecord(java.lang.String ddName, java.util.EnumSet<IPLIFile.Attr> declareFileAttributes, java.lang.String title, java.lang.String environment, int lineSize, int pageSize) PLIRecord constructor tests whether ecobol.jar is accessible and remembers file options declared on the DCL line.

Method Summary

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 for the declared 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 for the declared file
java.io.InputStream	inputStream() Throw an UNDEFINEDFILE CONDITION since PLIRecord files have the RECORD and not the STREAM
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() returns whether this file (may be) open.
boolean	isStream() For PLIRecord FILEs this always returns false
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() Throw an UNDEFINEDFILE CONDITION since PLIRecord files have the RECORD and not the STREAM
java.io.PrintStream	printStream() Throw an UNDEFINEDFILE CONDITION since PLIRecord files have the RECORD and not the STREAM
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 with the given key with the data and embedded key
java.util.Scanner	scanner() Throw an UNDEFINEDFILE CONDITION since PLIRecord files have the RECORD and not the STREAM
java.lang.String	toString() Returns the self-defining information for the debugger
boolean	write(byte[] record) Write the file with the record and specific relative record number
boolean	write(byte[] record, byte[] externalKey) Write the file with the record and specific relative record number
boolean	write(byte[] record, long rrn) Write the file with the record and specific relative record number

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

PLIRecord

public PLIRecord()

PLIRecord constructor tests whether ecobol.jar is accessible

PLIRecord

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

PLIRecord constructor tests whether ecobol.jar is accessible and remembers file options declared on the DCL line. options are checked at open time.

PLIRecord

public PLIRecord(IPLIFile dclFile,
                 java.lang.String title,
                 java.lang.String environment,
                 int lineSize,
                 int pageSize)

construct a PLIRecord 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

environment - - the FILE ENV option

lineSize - - ignored for RECORD files

pageSize - - ignored for RECORD files

Method Detail

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 PLIRecord FILEs this always returns false

Specified by:

isStream in interface IPLIFile

Returns:

true if STREAM

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()

Throw an UNDEFINEDFILE CONDITION since PLIRecord files have the RECORD and not the STREAM

Specified by:

printStream in interface IPLIFile

Returns:

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

inputStream

public java.io.InputStream inputStream()

Throw an UNDEFINEDFILE CONDITION since PLIRecord files have the RECORD and not the STREAM

Specified by:

inputStream in interface IPLIFile

Returns:

an InputStream for those files declared or opened with INPUT STREAM

outputStream

public java.io.OutputStream outputStream()

Throw an UNDEFINEDFILE CONDITION since PLIRecord files have the RECORD and not the STREAM

Specified by:

outputStream in interface IPLIFile

Returns:

a OutputStream for those files declared or opened with OUTPUT STREAM

scanner

public java.util.Scanner scanner()

Throw an UNDEFINEDFILE CONDITION since PLIRecord files have the RECORD and not the STREAM

Specified by:

scanner in interface IPLIFile

Returns:

an InputStream for those files declared or opened with INPUT STREAM

getData

public 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

Specified by:

getData in interface IPLIFile

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

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

Specified by:

getDDName in interface IPLIFile

Returns:

a string representation of 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

Specified by:

getDSName in interface IPLIFile

Returns:

a string representation of the Dataset name.

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, extend

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

locate

public boolean locate(byte[] key)

Locate a point within a keyed file, allowing subsequent read()s from that point forward

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 - if not open or no record found

read

public byte[] read(byte[] key)

Read a single record with a key

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, - Condition.CONDITION.ENDOFFILE

read

public byte[] read()

Read the next record (only if opened not-random)

Specified by:

read in interface IPLIFile

Returns:

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

Throws:

Condition.CONDITION.UNDEFINEDFILE, - Condition.CONDITION.ENDOFFILE

readPrev

public byte[] readPrev()

Read the previous record (only if opened not-random)

Specified by:

readPrev in interface IPLIFile

Returns:

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

Throws:

Condition.CONDITION.UNDEFINEDFILE, - Condition.CONDITION.ENDOFFILE

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, - Condition.CONDITION.ERROR

write

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

Write the file with the record and specific relative record number

Specified by:

write in interface IPLIFile

Parameters:

record - bytearray of the record

Returns:

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

Throws:

Condition.CONDITION.UNDEFINEDFILE

write

public boolean write(byte[] record)

Write the file with the record and specific relative record number

Specified by:

write in interface IPLIFile

Parameters:

record - bytearray of the record

Returns:

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

Throws:

Condition.CONDITION.UNDEFINEDFILE

write

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

Write the file with the record and specific relative record number

Specified by:

write in interface IPLIFile

Parameters:

record - bytearray of the record

Returns:

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

Throws:

Condition.CONDITION.UNDEFINEDFILE

rewrite

public boolean rewrite(byte[] record)

Rewrite the current record with the data and embedded key

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

rewrite

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

Rewrite the record with the given key with the data and embedded key

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

deleteByPrimary

public boolean deleteByPrimary(byte[] key)

Delete the record identified by the primary /relative record key passed in as a byte array

Specified by:

deleteByPrimary in interface IPLIFile

Returns:

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

Throws:

Condition.CONDITION.UNDEFINEDFILE

delete

public 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.

Specified by:

delete in interface IPLIFile

Returns:

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

Throws:

Condition.CONDITION.UNDEFINEDFILE

delete

public boolean delete()

Delete the current record (the last record read)

Specified by:

delete in interface IPLIFile

Returns:

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

isOpen

public boolean isOpen()

returns whether this file (may be) open.

Specified by:

isOpen in interface IPLIFile

Returns:

true if this file is currently open

Throws:

Condition.CONDITION.UNDEFINEDFILE - if already closed

close

public void close()

Close the file

Specified by:

close in interface IPLIFile

Throws:

Condition.CONDITION.UNDEFINEDFILE - if already closed

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 - not declared (w/ MISSINGFILEOPTS) or CONDITION.UNDEFINEDFILE permissiong denied or file doesn't exist (w/ FILEMISSING)