|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--xBaseJ.DBF
Field Summary | |
static byte |
DBASEIII
|
static byte |
DBASEIV
|
static char |
READ_ONLY
|
static java.lang.String |
xBaseJVersion
|
Constructor Summary | |
DBF(java.lang.String DBFname)
creates an DBF object and opens existing database file in read/write mode |
|
DBF(java.lang.String DBFname,
boolean destroy)
creates a new DBF file or replaces an existing database file, w/o format assumes dbaseiii file format |
|
DBF(java.lang.String DBFname,
boolean destroy,
java.lang.String inEncodeType)
creates a new DBF file or replaces an existing database file, w/o format assumes dbaseiii file format |
|
DBF(java.lang.String DBFname,
char readOnly)
creates an DBF object and opens existing database file in readonly mode |
|
DBF(java.lang.String DBFname,
char readOnly,
java.lang.String inEncodeType)
creates an DBF object and opens existing database file in readonly mode |
|
DBF(java.lang.String DBFname,
int format,
boolean destroy)
creates a new DBF file or replaces an existing database file |
|
DBF(java.lang.String DBFname,
int format,
boolean destroy,
java.lang.String inEncodeType)
creates a new DBF file or replaces an existing database file |
|
DBF(java.lang.String DBFname,
java.lang.String inEncodeType)
creates an DBF object and opens existing database file in read/write mode |
Method Summary | |
void |
addField(Field aField)
adds a new Field to a database |
void |
addField(Field[] aField)
adds an array of new Fields to a database |
void |
changeField(Field oldField,
Field newField)
changes a Field in a database NOT FULLY IMPLEMENTED |
void |
close()
closes the database |
Index |
createIndex(java.lang.String filename,
java.lang.String index,
boolean unique)
creates a new Index as a NDX file, assumes NDX file does not exist |
Index |
createIndex(java.lang.String filename,
java.lang.String index,
boolean destroy,
boolean unique)
creates a new Index as a NDX file |
Index |
createTag(java.lang.String tagname,
java.lang.String tagIndex,
boolean unique)
creates a tag in the MDX file |
void |
delete()
marks the current records as deleted |
boolean |
deleted()
returns true if record is marked for deletion |
void |
dropField(Field aField)
removes a Field from a database NOT FULLY IMPLEMENTED |
boolean |
find(java.lang.String keyString)
used to find a record with an equal or greater string value when done the record pointer and field contents will be changed |
boolean |
findExact(java.lang.String keyString)
used to find a record with an equal string value when done the record pointer and field contents will be changed only if the exact key is found |
void |
findNext()
used to get the next record in the index list when done the record pointer and field contents will be changed |
void |
findPrev()
used to get the previous record in the index list when done the record pointer and field contents will be changed |
int |
fldcount()
Deprecated. use getFieldCount |
int |
getCurrentRecordNumber()
returns the current record number |
static java.lang.String |
getEncodingType()
gets the character encoding string value |
Field |
getField(int i)
returns a Field object by its relative position |
Field |
getField(java.lang.String name)
returns a Field object by its name in the database |
int |
getFieldCount()
returns the number of fields in a database |
Index |
getIndex(int indexPosition)
gets an Index object associated with the database. |
int |
getIndexCount()
returns the number of known index files and tags |
java.lang.String |
getName()
returns the full path name of the database |
int |
getRecordCount()
returns the number of records in a database |
int |
getVersion()
returns the dbase version field |
java.io.File |
getXML(java.lang.String inFileName)
generates an xml string representation using xbase.dtd |
void |
gotoRecord(int recno)
used to read a record at a particular place in the database when done the record pointer and field contents will be changed |
void |
pack()
packs a DBF by removing deleted records and memo fields |
void |
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 |
void |
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 |
int |
reccount()
Deprecated. use getRecordCount |
int |
recno()
Deprecated. use getCurrentRecordNumber |
static void |
setEncodingType(java.lang.String inType)
sets the character encoding variable. |
void |
startBottom()
used to position record pointer at the last record or index in the database when done the record pointer will be changed. |
void |
startTop()
used to position record pointer at the first record or index in the database when done the record pointer will be changed. |
void |
undelete()
marks the current records as not deleted |
void |
update()
updates the record at the current position |
Index |
useIndex(Index ndx)
used to indicate the primary Index |
Index |
useIndex(java.lang.String filename)
opens an Index file associated with the database. |
Index |
useIndex(java.lang.String filename,
java.lang.String ID)
opens an Index file associated with the database |
Index |
useIndexByID(java.lang.String ID)
used to indicate the primary Index |
Index |
useTag(java.lang.String tagname)
associates all Index operations with an existing tag |
Index |
useTag(java.lang.String tagname,
java.lang.String ID)
associates all Index operations with an existing tag |
java.lang.String |
version()
|
void |
write()
used to write a new record in the database when done the record pointer is at the end of the database |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final byte DBASEIII
public static final byte DBASEIV
public static final char READ_ONLY
public static final java.lang.String xBaseJVersion
Constructor Detail |
public DBF(java.lang.String DBFname, boolean destroy) throws xBaseJException, java.io.IOException, java.lang.SecurityException
DBFname
- a new or existing database file, can be full or partial pathnameformat
- use class constants DBASEIII or DBASEIVxBaseJException
- File does exist and told not to destroy it.xBaseJException
- Told to destroy but operating system can not destroyjava.lang.SecurityException
- Java error caused by called methods, most likely trying to create on a remote systempublic DBF(java.lang.String DBFname, int format, boolean destroy) throws xBaseJException, java.io.IOException, java.lang.SecurityException
DBFname
- a new or existing database file, can be full or partial pathnameformat
- use class constants DBASEIII or DBASEIVdestroy
- permission to destroy an existing database filexBaseJException
- File does exist and told not to destroy it.xBaseJException
- Told to destroy but operating system can not destroyjava.lang.SecurityException
- Java error caused by called methods, most likely trying to create on a remote systempublic DBF(java.lang.String DBFname, char readOnly) throws xBaseJException, java.io.IOException
DBFname
- an existing database file, can be full or partial pathnamexBaseJException
- Can not find databasexBaseJException
- database not dbaseIII formatpublic DBF(java.lang.String DBFname) throws xBaseJException, java.io.IOException
DBFname
- an existing database file, can be full or partial pathnamexBaseJException
- Can not find databasexBaseJException
- database not dbaseIII formatpublic DBF(java.lang.String DBFname, boolean destroy, java.lang.String inEncodeType) throws xBaseJException, java.io.IOException, java.lang.SecurityException
DBFname
- a new or existing database file, can be full or partial pathnameformat
- use class constants DBASEIII or DBASEIVxBaseJException
- File does exist and told not to destroy it.xBaseJException
- Told to destroy but operating system can not destroyjava.lang.SecurityException
- Java error caused by called methods, most likely trying to create on a remote systempublic DBF(java.lang.String DBFname, int format, boolean destroy, java.lang.String inEncodeType) throws xBaseJException, java.io.IOException, java.lang.SecurityException
DBFname
- a new or existing database file, can be full or partial pathnameformat
- use class constants DBASEIII or DBASEIVdestroy
- permission to destroy an existing database filexBaseJException
- File does exist and told not to destroy it.xBaseJException
- Told to destroy but operating system can not destroyjava.lang.SecurityException
- Java error caused by called methods, most likely trying to create on a remote systempublic DBF(java.lang.String DBFname, char readOnly, java.lang.String inEncodeType) throws xBaseJException, java.io.IOException
DBFname
- an existing database file, can be full or partial pathnamexBaseJException
- Can not find databasexBaseJException
- database not dbaseIII formatpublic DBF(java.lang.String DBFname, java.lang.String inEncodeType) throws xBaseJException, java.io.IOException
DBFname
- an existing database file, can be full or partial pathnamexBaseJException
- Can not find databasexBaseJException
- database not dbaseIII formatMethod Detail |
public java.lang.String version()
public void addField(Field aField) throws xBaseJException, java.io.IOException
aField
- a predefined Field objectxBaseJException
- xBaseJ error caused by called methodsField
public void addField(Field[] aField) throws xBaseJException, java.io.IOException
aField
- an array of predefined Field objectxBaseJException
- passed an empty array or other errorField
public void dropField(Field aField) throws xBaseJException, java.io.IOException
aField
- a field in the databasexBaseJException
- Field is not part of the databaseField
public void changeField(Field oldField, Field newField) throws xBaseJException, java.io.IOException
aField
- a Field objectxBaseJException
- xBaseJ error caused by called methodsField
public int fldcount()
public int reccount()
public int recno()
public int getFieldCount()
public int getRecordCount()
public int getCurrentRecordNumber()
public int getIndexCount()
public Index getIndex(int indexPosition) throws xBaseJException
int
- index positionxBaseJException
- index value incorrectpublic Index useIndex(java.lang.String filename) throws xBaseJException, java.io.IOException
filename
- an existing ndx file(can be full or partial pathname) or mdx tagxBaseJException
- xBaseJ Fields defined in index do not match fields in databasepublic Index useIndex(java.lang.String filename, java.lang.String ID) throws xBaseJException, java.io.IOException
filename
- an existing Index file, can be full or partial pathnameID
- a unique id to define Index at run-time.xBaseJException
- xBaseJ Fields defined in Index do not match Fields in databasepublic Index useIndex(Index ndx) throws xBaseJException, java.io.IOException
Index
- a Index objectxBaseJException
- xBaseJ Index not opened or not part of the databasepublic Index useIndexByID(java.lang.String ID) throws xBaseJException
Index
- a string idxBaseJException
- xBaseJ Index not opened or not part of the databaseuseIndex(String,String)
public Index useTag(java.lang.String tagname) throws xBaseJException
tagname
- an existing tag name in the production MDX filexBaseJException
- no MDX file
tagname not foundpublic Index useTag(java.lang.String tagname, java.lang.String ID) throws xBaseJException, java.io.IOException
tagname
- an existing tag name in the production MDX fileID
- a unique id to define Index at run-time.xBaseJException
- no MDX file
tagname not foundpublic Index createIndex(java.lang.String filename, java.lang.String index, boolean unique) throws xBaseJException, java.io.IOException
filename
- a new Index file nameindex
- string identifying Fields used in Indexunique
- boolean to indicate if the key is always uniquexBaseJException
- NDX file already existspublic Index createIndex(java.lang.String filename, java.lang.String index, boolean destroy, boolean unique) throws xBaseJException, java.io.IOException
filename
- a new Index file nameindex
- string identifying Fields used in Indexdestroy
- permission to destory NDX if file existsunique
- boolean to indicate if the key is always uniquexBaseJException
- NDX file already existspublic Index createTag(java.lang.String tagname, java.lang.String tagIndex, boolean unique) throws xBaseJException, java.io.IOException
tagname
- a non-existing tag name in the production MDX filetagIndex
- string identifying Fields used in Indexunique
- boolean to indicate if the key is always uniquexBaseJException
- no MDX file
tagname already existspublic boolean find(java.lang.String keyString) throws xBaseJException, java.io.IOException
keyString
- a search stringxBaseJException
- xBaseJ no Indexs opened with databasepublic boolean findExact(java.lang.String keyString) throws xBaseJException, java.io.IOException
keyString
- a search stringxBaseJException
- xBaseJ no Indexs opened with databasepublic void findNext() throws xBaseJException, java.io.IOException
xBaseJException
- xBaseJ Index not opened or not part of the database
eof - end of filepublic void findPrev() throws xBaseJException, java.io.IOException
xBaseJException
- xBaseJ Index not opened or not part of the database
tof - top of filepublic void read() throws xBaseJException, java.io.IOException
xBaseJException
- usually the end of file conditionpublic void readPrev() throws xBaseJException, java.io.IOException
xBaseJException
- usually the top of file conditionpublic void gotoRecord(int recno) throws xBaseJException, java.io.IOException
recno
- the relative position of the record to readxBaseJException
- passed an negative number, 0 or value greater than the number of records in databasepublic void startTop() throws xBaseJException, java.io.IOException
xBaseJException
- most likely no records in databasepublic void startBottom() throws xBaseJException, java.io.IOException
xBaseJException
- most likely no records in databasepublic void write() throws xBaseJException, java.io.IOException
xBaseJException
- any one of several errorspublic void update() throws xBaseJException, java.io.IOException
xBaseJException
- any one of several errorspublic void delete() throws java.io.IOException, xBaseJException
xBaseJException
- usually occurs when no record has been readpublic void undelete() throws java.io.IOException, xBaseJException
xBaseJException
- usually occurs when no record has been read.public void close() throws java.io.IOException
public Field getField(int i) throws java.lang.ArrayIndexOutOfBoundsException, xBaseJException
i
- Field numberxBaseJException
- usually occurs when Field number is less than 1 or greater than the number of fieldspublic Field getField(java.lang.String name) throws xBaseJException, java.lang.ArrayIndexOutOfBoundsException
name
- Field namexBaseJException
- Field name is not correctpublic java.lang.String getName()
public boolean deleted()
public void pack() throws xBaseJException, java.io.IOException, java.lang.SecurityException, java.lang.CloneNotSupportedException
xBaseJException
- File does exist and told not to destroy it.xBaseJException
- Told to destroy but operating system can not destroyjava.lang.CloneNotSupportedException
- Java error caused by called methodspublic int getVersion()
public static void setEncodingType(java.lang.String inType)
String
- encoding type, default is "8859_1" could use "CP850" otherspublic static java.lang.String getEncodingType()
public java.io.File getXML(java.lang.String inFileName) throws java.io.IOException, xBaseJException
inFileName
- - String
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |