All Packages Class Hierarchy This Package Previous Next Index
Class xBaseJ.DBF
java.lang.Object
|
+----xBaseJ.DBF
- public class DBF
- extends Object
-
DBASEIII
-
-
DBASEIV
-
-
READ_ONLY
-
-
DBF(String)
- creates an DBF object and opens existing database file in read/write mode
The unregistered package limitted to 5 open dbf's.
-
DBF(String, boolean)
- creates a new DBF file or replaces an existing database file, w/o format assumes dbaseiii file format
The unregistered package limitted to 5 open dbf's.
-
DBF(String, char)
- creates an DBF object and opens existing database file in readonly mode
The unregistered package limitted to 5 open dbf's.
-
DBF(String, int, boolean)
- creates a new DBF file or replaces an existing database file
The unregistered package limitted to 5 open dbf's.
-
addField(Field)
-
adds a new Field to a database
-
addField(Field[])
-
adds an array of new Fields to a database
-
changeField(Field, Field)
-
changes a Field in a database NOT FULLY IMPLEMENTED
-
close()
-
closes the database
-
createIndex(String, String, boolean)
-
creates a new Index as a NDX file, assumes NDX file does not exist
-
createIndex(String, String, boolean, boolean)
-
creates a new Index as a NDX file
-
createTag(String, String, boolean)
-
creates a tag in the MDX file
-
delete()
-
marks the current records as deleted
-
deleted()
-
returns true if record is marked for deletion
-
dropField(Field)
-
removes a Field from a database NOT FULLY IMPLEMENTED
-
find(String)
-
used to find a record with an equal or greater string value
when done the record pointer and field contents will be changed
-
findNext()
-
used to get the next record in the index list
when done the record pointer and field contents will be changed
-
findPrev()
-
used to get the previous record in the index list
when done the record pointer and field contents will be changed
-
fldcount()
-
returns the number of fields in a database
Deprecated.
-
getCurrentRecordNumber()
-
returns the current record number
-
getField(int)
-
returns a Field object by its relative position
-
getField(String)
-
returns a Field object by its name in the database
-
getFieldCount()
-
returns the number of fields in a database
-
getIndex(int)
-
gets an Index object associated with the database.
-
getIndexCount()
-
returns the number of known index files and tags
-
getName()
-
returns the full path name of the database
-
getRecordCount()
-
returns the number of records in a database
-
gotoRecord(int)
-
used to read a record at a particular place in the database
when done the record pointer and field contents will be changed
-
pack()
- packs a DBF by removing deleted records and memo fields
-
read()
-
used to read the next record, after the current record pointer, in the database
when done the record pointer and field contents will be changed
-
readPrev()
-
used to read the previous record, before the current record pointer, in the database
when done the record pointer and field contents will be changed
-
reccount()
-
returns the number of records in a database
Deprecated.
-
recno()
-
returns the current record number
Deprecated.
-
setFieldEvaluation(String)
-
-
startBottom()
-
used to position record pointer at the last record or index in the database
when done the record pointer will be changed.
-
startTop()
-
used to position record pointer at the first record or index in the database
when done the record pointer will be changed.
-
undelete()
-
marks the current records as not deleted
-
update()
-
updates the record at the current position
-
useIndex(Index)
-
used to indicate the primary Index
-
useIndex(String)
-
opens an Index file associated with the database.
-
useIndex(String, String)
-
opens an Index file associated with the database
-
useIndexByID(String)
-
used to indicate the primary Index
-
useTag(String)
-
associates all Index operations with an existing tag
-
useTag(String, String)
-
associates all Index operations with an existing tag
-
version()
-
-
write()
-
used to write a new record in the database
when done the record pointer is at the end of the database
DBASEIII
public static final byte DBASEIII
DBASEIV
public static final byte DBASEIV
READ_ONLY
public static final char READ_ONLY
DBF
public DBF(String DBFname,
boolean destroy) throws xBaseJException, IOException, SecurityException
- creates a new DBF file or replaces an existing database file, w/o format assumes dbaseiii file format
The unregistered package limitted to 5 open dbf's.
- Parameters:
- DBFname - a new or existing database file, can be full or partial pathname
- format - use class constants DBASEIII or DBASEIV
- Throws: xBaseJException
- File does exist and told not to destroy it.
- Throws: xBaseJException
- Told to destroy but operating system can not destroy
- Throws: SecurityException
- Java error caused by called methods, most likely trying to create on a remote system
DBF
public DBF(String DBFname,
int format,
boolean destroy) throws xBaseJException, IOException, SecurityException
- creates a new DBF file or replaces an existing database file
The unregistered package limitted to 5 open dbf's.
- Parameters:
- DBFname - a new or existing database file, can be full or partial pathname
- format - use class constants DBASEIII or DBASEIV
- destroy - permission to destroy an existing database file
- Throws: xBaseJException
- File does exist and told not to destroy it.
- Throws: xBaseJException
- Told to destroy but operating system can not destroy
- Throws: SecurityException
- Java error caused by called methods, most likely trying to create on a remote system
DBF
public DBF(String DBFname,
char readOnly) throws xBaseJException, IOException
- creates an DBF object and opens existing database file in readonly mode
The unregistered package limitted to 5 open dbf's.
- Parameters:
- DBFname - an existing database file, can be full or partial pathname
- Throws: xBaseJException
- Can not find database
- Throws: xBaseJException
- database not dbaseIII format
DBF
public DBF(String DBFname) throws xBaseJException, IOException
- creates an DBF object and opens existing database file in read/write mode
The unregistered package limitted to 5 open dbf's.
- Parameters:
- DBFname - an existing database file, can be full or partial pathname
- Throws: xBaseJException
- Can not find database
- Throws: xBaseJException
- database not dbaseIII format
version
public String version()
addField
public void addField(Field aField) throws xBaseJException, IOException
- adds a new Field to a database
- Parameters:
- aField - a predefined Field object
- Throws: xBaseJException
- xBaseJ error caused by called methods
- See Also:
- Field
addField
public void addField(Field aField[]) throws xBaseJException, IOException
- adds an array of new Fields to a database
- Parameters:
- aField - an array of predefined Field object
- Throws: xBaseJException
- passed an empty array or other error
- See Also:
- Field
dropField
public void dropField(Field aField) throws xBaseJException, IOException
- removes a Field from a database NOT FULLY IMPLEMENTED
- Parameters:
- aField - a field in the database
- Throws: xBaseJException
- Field is not part of the database
- See Also:
- Field
changeField
public void changeField(Field oldField,
Field newField) throws xBaseJException, IOException
- changes a Field in a database NOT FULLY IMPLEMENTED
- Parameters:
- aField - a Field object
- Throws: xBaseJException
- xBaseJ error caused by called methods
- See Also:
- Field
fldcount
public int fldcount()
- Note: fldcount() is deprecated.
use getFieldCount
- returns the number of fields in a database
reccount
public int reccount()
- Note: reccount() is deprecated.
use getRecordCount
- returns the number of records in a database
recno
public int recno()
- Note: recno() is deprecated.
use getCurrentRecordNumber
- returns the current record number
getFieldCount
public int getFieldCount()
- returns the number of fields in a database
getRecordCount
public int getRecordCount()
- returns the number of records in a database
getCurrentRecordNumber
public int getCurrentRecordNumber()
- returns the current record number
getIndexCount
public int getIndexCount()
- returns the number of known index files and tags
getIndex
public Index getIndex(int indexPosition) throws xBaseJException
- gets an Index object associated with the database. This index does not become the primary
index. Written for the makeDBFBean application. Position is relative to 1.
- Parameters:
- int - index position
- Throws: xBaseJException
- index value incorrect
useIndex
public Index useIndex(String filename) throws xBaseJException, IOException
- opens an Index file associated with the database. This index becomes the primary
index used in subsequent find methods.
- Parameters:
- filename - an existing ndx file(can be full or partial pathname) or mdx tag
- Throws: xBaseJException
- xBaseJ Fields defined in index do not match fields in database
useIndex
public Index useIndex(String filename,
String ID) throws xBaseJException, IOException
- opens an Index file associated with the database
- Parameters:
- filename - an existing Index file, can be full or partial pathname
- ID - a unique id to define Index at run-time.
- Throws: xBaseJException
- xBaseJ Fields defined in Index do not match Fields in database
useIndex
public Index useIndex(Index ndx) throws xBaseJException, IOException
- used to indicate the primary Index
- Parameters:
- Index - a Index object
- Throws: xBaseJException
- xBaseJ Index not opened or not part of the database
useIndexByID
public Index useIndexByID(String ID) throws xBaseJException
- used to indicate the primary Index
- Parameters:
- Index - a string id
- Throws: xBaseJException
- xBaseJ Index not opened or not part of the database
- See Also:
- useIndex
useTag
public Index useTag(String tagname) throws xBaseJException
- associates all Index operations with an existing tag
- Parameters:
- tagname - an existing tag name in the production MDX file
- Throws: xBaseJException
- no MDX file
tagname not found
useTag
public Index useTag(String tagname,
String ID) throws xBaseJException, IOException
- associates all Index operations with an existing tag
- Parameters:
- tagname - an existing tag name in the production MDX file
- ID - a unique id to define Index at run-time.
- Throws: xBaseJException
- no MDX file
tagname not found
createIndex
public Index createIndex(String filename,
String index,
boolean unique) throws xBaseJException, IOException
- creates a new Index as a NDX file, assumes NDX file does not exist
- Parameters:
- filename - a new Index file name
- index - string identifying Fields used in Index
- unique - boolean to indicate if the key is always unique
- Throws: xBaseJException
- NDX file already exists
createIndex
public Index createIndex(String filename,
String index,
boolean destroy,
boolean unique) throws xBaseJException, IOException
- creates a new Index as a NDX file
- Parameters:
- filename - a new Index file name
- index - string identifying Fields used in Index
- destroy - permission to destory NDX if file exists
- unique - boolean to indicate if the key is always unique
- Throws: xBaseJException
- NDX file already exists
createTag
public Index createTag(String tagname,
String tagIndex,
boolean unique) throws xBaseJException, IOException
- creates a tag in the MDX file
- Parameters:
- tagname - a non-existing tag name in the production MDX file
- tagIndex - string identifying Fields used in Index
- unique - boolean to indicate if the key is always unique
- Throws: xBaseJException
- no MDX file
tagname already exists
find
public boolean find(String keyString) throws xBaseJException, IOException
- used to find a record with an equal or greater string value
when done the record pointer and field contents will be changed
- Parameters:
- keyString - a search string
- Returns:
- s boolean indicating if the record found contains the exact key
- Throws: xBaseJException
- xBaseJ no Indexs opened with database
findNext
public void findNext() throws xBaseJException, IOException
- used to get the next record in the index list
when done the record pointer and field contents will be changed
- Throws: xBaseJException
- xBaseJ Index not opened or not part of the database
eof - end of file
findPrev
public void findPrev() throws xBaseJException, IOException
- used to get the previous record in the index list
when done the record pointer and field contents will be changed
- Throws: xBaseJException
- xBaseJ Index not opened or not part of the database
tof - top of file
read
public void read() throws xBaseJException, IOException
- used to read the next record, after the current record pointer, in the database
when done the record pointer and field contents will be changed
- Throws: xBaseJException
- usually the end of file condition
readPrev
public void readPrev() throws xBaseJException, IOException
- used to read the previous record, before the current record pointer, in the database
when done the record pointer and field contents will be changed
- Throws: xBaseJException
- usually the top of file condition
gotoRecord
public void gotoRecord(int recno) throws xBaseJException, IOException
- used to read a record at a particular place in the database
when done the record pointer and field contents will be changed
- Parameters:
- recno - the relative position of the record to read
- Throws: xBaseJException
- passed an negative number, 0 or value greater than the number of records in database
startTop
public void startTop() throws xBaseJException, IOException
- used to position record pointer at the first record or index in the database
when done the record pointer will be changed. NO RECORD IS READ.
Your program should follow this with either a read (for non-index reads) or findNext (for index processing)
- Throws: xBaseJException
- most likely no records in database
startBottom
public void startBottom() throws xBaseJException, IOException
- used to position record pointer at the last record or index in the database
when done the record pointer will be changed. NO RECORD IS READ.
Your program should follow this with either a read (for non-index reads) or findPrev (for index processing)
- Throws: xBaseJException
- most likely no records in database
write
public void write() throws xBaseJException, IOException
- used to write a new record in the database
when done the record pointer is at the end of the database
- Throws: xBaseJException
- any one of several errors
update
public void update() throws xBaseJException, IOException
- updates the record at the current position
- Throws: xBaseJException
- any one of several errors
delete
public void delete() throws IOException, xBaseJException
- marks the current records as deleted
- Throws: xBaseJException
- usually occurs when no record has been read
undelete
public void undelete() throws IOException, xBaseJException
- marks the current records as not deleted
- Throws: xBaseJException
- usually occurs when no record has been read.
close
public void close() throws IOException
- closes the database
getField
public Field getField(int i) throws ArrayIndexOutOfBoundsException, xBaseJException
- returns a Field object by its relative position
- Parameters:
- i - Field number
- Throws: xBaseJException
- usually occurs when Field number is less than 1 or greater than the number of fields
getField
public Field getField(String name) throws xBaseJException, ArrayIndexOutOfBoundsException
- returns a Field object by its name in the database
- Parameters:
- name - Field name
- Throws: xBaseJException
- Field name is not correct
getName
public String getName()
- returns the full path name of the database
deleted
public boolean deleted()
- returns true if record is marked for deletion
pack
public void pack() throws xBaseJException, IOException, SecurityException, CloneNotSupportedException
- packs a DBF by removing deleted records and memo fields
- Throws: xBaseJException
- File does exist and told not to destroy it.
- Throws: xBaseJException
- Told to destroy but operating system can not destroy
- Throws: CloneNotSupportedException
- Java error caused by called methods
setFieldEvaluation
public void setFieldEvaluation(String evalString) throws xBaseJException
All Packages Class Hierarchy This Package Previous Next Index