All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class asjava.uniobjects.UniDictionary

java.lang.Object
   |
   +----asjava.uniobjects.UniBase
           |
           +----asjava.uniobjects.UniFile
                   |
                   +----asjava.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

Version:
Version 1.0
Author:
David T. Meeks

Constructor Index

 o UniDictionary()
Constructs a UniDictionary object
 o UniDictionary(UniSession, Object, int)

Method Index

 o getAssoc()
Returns the current ASSOC field from the dictionary
 o getAssoc(Object)
Returns the current ASSOC field from the dictionary for the record ID specified
 o getConv()
Returns the current CONV field from the dictionary
 o getConv(Object)
Returns the current CONV field from the dictionary for the recordID specified
 o getFormat()
Returns the current FORMAT field from the dictionary
 o getFormat(Object)
Returns the current FORMAT field from the dictionary for the recordID specified
 o getLoc()
Returns the current LOC field from the dictionary
 o getLoc(Object)
Returns the current LOC field from the dictionary for the recordID specified
 o getName()
Returns the current NAME field from the dictionary
 o getName(Object)
Returns the current NAME field from the dictionary for the recordID specified
 o getSM()
Returns the current SM field (single/multivalued) from the dictionary
 o getSM(Object)
Returns the current SM field (single/multivalued) from the dictionary for the field specified
 o getSQLType()
Returns the current SQLTYPE field from the dictionary
 o getSQLType(Object)
Returns the current SQLTYPE field from the dictionary for the field specified
 o getType()
Returns the current TYPE field from the dictionary
 o getType(Object)
Returns the current TYPE field from the dictionary for the recordID specified
 o setAssoc(Object)
Sets the ASSOC field from the dictionary to the String passed in
 o setAssoc(Object, Object)
Sets the ASSOC field of the recordID specified from the dictionary to the String passed in
 o setConv(Object)
Sets the CONV field from the dictionary to the String passed in
 o setConv(Object, Object)
Sets the CONV field for the specified recordID from the dictionary to the String passed in
 o setFormat(Object)
Sets the FORMAT field from the dictionary to the String passed in
 o setFormat(Object, Object)
Sets the FORMAT field for the recordID specified from the dictionary to the String passed in
 o setLoc(Object)
Sets the LOC field from the dictionary to the String passed in
 o setLoc(Object, Object)
Sets the LOC field for the recordID specified from the dictionary to the String passed in
 o setName(Object)
Sets the NAME field from the dictionary to the String passed in
 o setName(Object, Object)
Sets the NAME field for the recordID specified from the dictionary to the String passed in
 o setSM(Object)
Sets the SM (single/multivalued) field from the dictionary to the String passed in
 o setSM(Object, Object)
Sets the SM (single/multivalued) field for the recordID specified from the dictionary to the String passed in
 o setSQLType(Object)
Sets the SQLTYPE field from the dictionary to the String passed in
 o setSQLType(Object, Object)
Sets the SQLTYPE field for the recordID specified from the dictionary to the String passed in
 o setType(Object)
Sets the TYPE field from the dictionary to the String passed in
 o setType(Object, Object)
Sets the TYPE field for the recordID specified from the dictionary to the String passed in

Constructors

 o UniDictionary
 public UniDictionary() throws UniFileException
Constructs a UniDictionary object

Throws: UniFileException
is thrown if an error occurs
 o UniDictionary
 public UniDictionary(UniSession aSession,
                      Object aDictName,
                      int dictFlag) throws UniFileException

Methods

 o 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
See Also:
setAssoc
 o getAssoc
 public UniString getAssoc(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
See Also:
setAssoc
 o setAssoc
 public void setAssoc(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
See Also:
getAssoc
 o setAssoc
 public void setAssoc(Object aRecordID,
                      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
See Also:
getAssoc
 o 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
See Also:
setConv
 o getConv
 public UniString getConv(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
See Also:
setConv
 o setConv
 public void setConv(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
See Also:
getConv
 o setConv
 public void setConv(Object aRecordID,
                     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
See Also:
getConv
 o 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
See Also:
setFormat
 o getFormat
 public UniString getFormat(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
See Also:
setFormat
 o setFormat
 public void setFormat(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
See Also:
getFormat
 o setFormat
 public void setFormat(Object aRecordID,
                       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
See Also:
getFormat
 o 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
See Also:
setLoc
 o getLoc
 public UniString getLoc(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
See Also:
setLoc
 o setLoc
 public void setLoc(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
See Also:
getLoc
 o setLoc
 public void setLoc(Object aRecordID,
                    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
See Also:
getLoc
 o 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
See Also:
setName
 o getName
 public UniString getName(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
See Also:
setName
 o setName
 public void setName(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
See Also:
getName
 o setName
 public void setName(Object aRecordID,
                     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
See Also:
getName
 o 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
See Also:
setSM
 o getSM
 public UniString getSM(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
See Also:
setSM
 o setSM
 public void setSM(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
See Also:
getSM
 o setSM
 public void setSM(Object aRecordID,
                   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
See Also:
getSM
 o 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
See Also:
setSQLType
 o getSQLType
 public UniString getSQLType(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
See Also:
setSQLType
 o setSQLType
 public void setSQLType(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
See Also:
getSQLType
 o setSQLType
 public void setSQLType(Object aRecordID,
                        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
See Also:
getSQLType
 o 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
See Also:
setType
 o getType
 public UniString getType(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
See Also:
setType
 o setType
 public void setType(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
See Also:
getType
 o setType
 public void setType(Object aRecordID,
                     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
See Also:
getType

All Packages  Class Hierarchy  This Package  Previous  Next  Index