asjava.uniobjects
Class UniDictionary

java.lang.Object
  extended byasjava.uniobjects.UniBase
      extended byasjava.uniobjects.UniFile
          extended byasjava.uniobjects.UniDictionary

public class UniDictionary
extends UniFile

UniDictionary is used to control access to UniVerse dictionary files. It is an extension of the standard UniFile class

Since:
UNIOBJECTS 1.0
Version:
Version 1.0
Author:
David T. Meeks

Field Summary
 
Fields inherited from class asjava.uniobjects.UniFile
uniFileHandle
 
Fields inherited from class asjava.uniobjects.UniBase
inPacket, outPacket, uniConnection, uniEncryptionType, uniParentSession, uniStatus
 
Constructor Summary
UniDictionary()
          Constructs a UniDictionary object
UniDictionary(UniSession aSession, java.lang.Object aDictName, int dictFlag)
           
 
Method Summary
 UniString getAssoc()
          Returns the current ASSOC field from the dictionary
 UniString getAssoc(java.lang.Object aRecordID)
          Returns the current ASSOC field from the dictionary for the record ID specified
 UniString getConv()
          Returns the current CONV field from the dictionary
 UniString getConv(java.lang.Object aRecordID)
          Returns the current CONV field from the dictionary for the recordID specified
 UniString getFormat()
          Returns the current FORMAT field from the dictionary
 UniString getFormat(java.lang.Object aRecordID)
          Returns the current FORMAT field from the dictionary for the recordID specified
 UniString getLoc()
          Returns the current LOC field from the dictionary
 UniString getLoc(java.lang.Object aRecordID)
          Returns the current LOC field from the dictionary for the recordID specified
 UniString getName()
          Returns the current NAME field from the dictionary
 UniString getName(java.lang.Object aRecordID)
          Returns the current NAME field from the dictionary for the recordID specified
 UniString getSM()
          Returns the current SM field (single/multivalued) from the dictionary
 UniString getSM(java.lang.Object aRecordID)
          Returns the current SM field (single/multivalued) from the dictionary for the field specified
 UniString getSQLType()
          Returns the current SQLTYPE field from the dictionary
 UniString getSQLType(java.lang.Object aRecordID)
          Returns the current SQLTYPE field from the dictionary for the field specified
 UniString getType()
          Returns the current TYPE field from the dictionary
 UniString getType(java.lang.Object aRecordID)
          Returns the current TYPE field from the dictionary for the recordID specified
 void setAssoc(java.lang.Object aString)
          Sets the ASSOC field from the dictionary to the String passed in
 void setAssoc(java.lang.Object aRecordID, java.lang.Object aString)
          Sets the ASSOC field of the recordID specified from the dictionary to the String passed in
 void setConv(java.lang.Object aString)
          Sets the CONV field from the dictionary to the String passed in
 void setConv(java.lang.Object aRecordID, java.lang.Object aString)
          Sets the CONV field for the specified recordID from the dictionary to the String passed in
 void setFormat(java.lang.Object aString)
          Sets the FORMAT field from the dictionary to the String passed in
 void setFormat(java.lang.Object aRecordID, java.lang.Object aString)
          Sets the FORMAT field for the recordID specified from the dictionary to the String passed in
 void setLoc(java.lang.Object aString)
          Sets the LOC field from the dictionary to the String passed in
 void setLoc(java.lang.Object aRecordID, java.lang.Object aString)
          Sets the LOC field for the recordID specified from the dictionary to the String passed in
 void setName(java.lang.Object aString)
          Sets the NAME field from the dictionary to the String passed in
 void setName(java.lang.Object aRecordID, java.lang.Object aString)
          Sets the NAME field for the recordID specified from the dictionary to the String passed in
 void setSM(java.lang.Object aString)
          Sets the SM (single/multivalued) field from the dictionary to the String passed in
 void setSM(java.lang.Object aRecordID, java.lang.Object aString)
          Sets the SM (single/multivalued) field for the recordID specified from the dictionary to the String passed in
 void setSQLType(java.lang.Object aString)
          Sets the SQLTYPE field from the dictionary to the String passed in
 void setSQLType(java.lang.Object aRecordID, java.lang.Object aString)
          Sets the SQLTYPE field for the recordID specified from the dictionary to the String passed in
 void setType(java.lang.Object aString)
          Sets the TYPE field from the dictionary to the String passed in
 void setType(java.lang.Object aRecordID, java.lang.Object aString)
          Sets the TYPE field for the recordID specified from the dictionary to the String passed in
 
Methods inherited from class asjava.uniobjects.UniFile
clearFile, close, deleteRecord, deleteRecord, deleteRecord, fileAction, getAkInfo, getBlockingStrategy, getFileName, getFileType, getLockStrategy, getRecord, getRecordID, getReleaseStrategy, isOpen, isRecordLocked, isRecordLocked, iType, lockFile, lockRecord, lockRecord, lockRecord, open, read, read, read, read, readField, readField, readField, readField, readNamedField, readNamedField, readNamedField, setBlockingStrategy, setFileName, setLockStrategy, setRecord, setRecordID, setReleaseStrategy, unlockFile, unlockRecord, unlockRecord, unlockRecord, write, write, write, write, writeField, writeField, writeField, writeField, writeField, writeNamedField, writeNamedField, writeNamedField
 
Methods inherited from class asjava.uniobjects.UniBase
getEncryptionType, isCommandActive, setEncryptionType, status
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UniDictionary

public UniDictionary()
              throws UniFileException
Constructs a UniDictionary object

Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0

UniDictionary

public UniDictionary(UniSession aSession,
                     java.lang.Object aDictName,
                     int dictFlag)
              throws UniFileException
Method Detail

getAssoc

public UniString getAssoc()
                   throws UniFileException
Returns the current ASSOC field from the dictionary

Returns:
a UniString representing the ASSOC field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setAssoc(java.lang.Object)

getAssoc

public UniString getAssoc(java.lang.Object aRecordID)
                   throws UniFileException
Returns the current ASSOC field from the dictionary for the record ID specified

Parameters:
aRecordID - String representing which recordID from the dictionary to examine
Returns:
a UniString representing the ASSOC field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setAssoc(java.lang.Object)

setAssoc

public void setAssoc(java.lang.Object aString)
              throws UniFileException
Sets the ASSOC field from the dictionary to the String passed in

Parameters:
aString - a String representing the new value of the ASSOC field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getAssoc()

setAssoc

public void setAssoc(java.lang.Object aRecordID,
                     java.lang.Object aString)
              throws UniFileException
Sets the ASSOC field of the recordID specified from the dictionary to the String passed in

Parameters:
aRecordID - a String representing the recordID to be modified
aString - a String representing the new value of the ASSOC field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getAssoc()

getConv

public UniString getConv()
                  throws UniFileException
Returns the current CONV field from the dictionary

Returns:
a UniString representing the CONV field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setConv(java.lang.Object)

getConv

public UniString getConv(java.lang.Object aRecordID)
                  throws UniFileException
Returns the current CONV field from the dictionary for the recordID specified

Parameters:
aRecordID - a String representing the recordID to be examined
Returns:
a UniString representing the CONV field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setConv(java.lang.Object)

setConv

public void setConv(java.lang.Object aString)
             throws UniFileException
Sets the CONV field from the dictionary to the String passed in

Parameters:
aString - a String representing the new value of the CONV field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getConv()

setConv

public void setConv(java.lang.Object aRecordID,
                    java.lang.Object aString)
             throws UniFileException
Sets the CONV field for the specified recordID from the dictionary to the String passed in

Parameters:
aRecordID - a String representing the recordID from the dictionary to modify
aString - a String representing the new value of the CONV field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getConv()

getFormat

public UniString getFormat()
                    throws UniFileException
Returns the current FORMAT field from the dictionary

Returns:
a UniString representing the FORMAT field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setFormat(java.lang.Object)

getFormat

public UniString getFormat(java.lang.Object aRecordID)
                    throws UniFileException
Returns the current FORMAT field from the dictionary for the recordID specified

Parameters:
aRecordID - a String representing which recordID to examine
Returns:
a UniString representing the FORMAT field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setFormat(java.lang.Object)

setFormat

public void setFormat(java.lang.Object aString)
               throws UniFileException
Sets the FORMAT field from the dictionary to the String passed in

Parameters:
aString - a String representing the new value of the FORMAT field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getFormat()

setFormat

public void setFormat(java.lang.Object aRecordID,
                      java.lang.Object aString)
               throws UniFileException
Sets the FORMAT field for the recordID specified from the dictionary to the String passed in

Parameters:
aRecordID - a String representing the recordID from the dictionary to modify
aString - a String representing the new value of the FORMAT field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getFormat()

getLoc

public UniString getLoc()
                 throws UniFileException
Returns the current LOC field from the dictionary

Returns:
a UniString representing the LOC field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setLoc(java.lang.Object)

getLoc

public UniString getLoc(java.lang.Object aRecordID)
                 throws UniFileException
Returns the current LOC field from the dictionary for the recordID specified

Parameters:
aRecordID - a String representing which recordID to examine
Returns:
a UniString representing the LOC field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setLoc(java.lang.Object)

setLoc

public void setLoc(java.lang.Object aString)
            throws UniFileException
Sets the LOC field from the dictionary to the String passed in

Parameters:
aString - a String representing the new value of the LOC field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getLoc()

setLoc

public void setLoc(java.lang.Object aRecordID,
                   java.lang.Object aString)
            throws UniFileException
Sets the LOC field for the recordID specified from the dictionary to the String passed in

Parameters:
aRecordID - a String representing the recordID from the dictionary to modify
aString - a String representing the new value of the LOC field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getLoc()

getName

public UniString getName()
                  throws UniFileException
Returns the current NAME field from the dictionary

Returns:
a UniString representing the NAME field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setName(java.lang.Object)

getName

public UniString getName(java.lang.Object aRecordID)
                  throws UniFileException
Returns the current NAME field from the dictionary for the recordID specified

Parameters:
aRecordID - a String representing which recordID from the dictionary to examine
Returns:
a UniString representing the NAME field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setName(java.lang.Object)

setName

public void setName(java.lang.Object aString)
             throws UniFileException
Sets the NAME field from the dictionary to the String passed in

Parameters:
aString - a String representing the new value of the NAME field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getName()

setName

public void setName(java.lang.Object aRecordID,
                    java.lang.Object aString)
             throws UniFileException
Sets the NAME field for the recordID specified from the dictionary to the String passed in

Parameters:
aRecordID - a String representing which recordID from the dictionary to modify
aString - a String representing the new value of the NAME field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getName()

getSM

public UniString getSM()
                throws UniFileException
Returns the current SM field (single/multivalued) from the dictionary

Returns:
a UniString representing the SM field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setSM(java.lang.Object)

getSM

public UniString getSM(java.lang.Object aRecordID)
                throws UniFileException
Returns the current SM field (single/multivalued) from the dictionary for the field specified

Parameters:
aRecordID - a String representing which recordID to examine
Returns:
a UniString representing the SM field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setSM(java.lang.Object)

setSM

public void setSM(java.lang.Object aString)
           throws UniFileException
Sets the SM (single/multivalued) field from the dictionary to the String passed in

Parameters:
aString - a String representing the new value of the SM field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getSM()

setSM

public void setSM(java.lang.Object aRecordID,
                  java.lang.Object aString)
           throws UniFileException
Sets the SM (single/multivalued) field for the recordID specified from the dictionary to the String passed in

Parameters:
aRecordID - a String representing which dictionary recordID to modify
aString - a String representing the new value of the SM field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getSM()

getSQLType

public UniString getSQLType()
                     throws UniFileException
Returns the current SQLTYPE field from the dictionary

Returns:
a UniString representing the SQLTYPE field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setSQLType(java.lang.Object)

getSQLType

public UniString getSQLType(java.lang.Object aRecordID)
                     throws UniFileException
Returns the current SQLTYPE field from the dictionary for the field specified

Parameters:
aRecordID - a String representing which recordID to examine
Returns:
a UniString representing the SQLTYPE field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setSQLType(java.lang.Object)

setSQLType

public void setSQLType(java.lang.Object aString)
                throws UniFileException
Sets the SQLTYPE field from the dictionary to the String passed in

Parameters:
aString - a String representing the new value of the SQLTYPE field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getSQLType()

setSQLType

public void setSQLType(java.lang.Object aRecordID,
                       java.lang.Object aString)
                throws UniFileException
Sets the SQLTYPE field for the recordID specified from the dictionary to the String passed in

Parameters:
aRecordID - a String representing which dictionary recordID to modify
aString - a String representing the new value of the SQLTYPE field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getSQLType()

getType

public UniString getType()
                  throws UniFileException
Returns the current TYPE field from the dictionary

Returns:
a UniString representing the TYPE field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setType(java.lang.Object)

getType

public UniString getType(java.lang.Object aRecordID)
                  throws UniFileException
Returns the current TYPE field from the dictionary for the recordID specified

Parameters:
aRecordID - a String representing which recordID to examine
Returns:
a UniString representing the TYPE field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
setType(java.lang.Object)

setType

public void setType(java.lang.Object aString)
             throws UniFileException
Sets the TYPE field from the dictionary to the String passed in

Parameters:
aString - a String representing the new value of the TYPE field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getType()

setType

public void setType(java.lang.Object aRecordID,
                    java.lang.Object aString)
             throws UniFileException
Sets the TYPE field for the recordID specified from the dictionary to the String passed in

Parameters:
aRecordID - a String representing which dictionary recordID to modify
aString - a String representing the new value of the TYPE field
Throws:
UniFileException - is thrown if an error occurs
Since:
UNIOBJECTS 1.0
See Also:
getType()