All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class asjava.uniclientlibs.UniDynArray

java.lang.Object
   |
   +----asjava.uniclientlibs.UniString
           |
           +----asjava.uniclientlibs.UniDynArray

public class UniDynArray
extends UniString
implements Serializable
UniDynArray is used to control dynamic array interaction. It is important to note that UniDynArray referencing is done in '1'-based notation, meaning the first field is field 1.

Version:
Version 1.0
Author:
David T. Meeks

Constructor Index

 o UniDynArray()
Constructs a dynamic array with no characters in it
 o UniDynArray(Object)
Constructs a dynamic array with the passed in Object value
 o UniDynArray(String)
Constructs a dynamic array with the passed in Object value

Method Index

 o count()
Counts the number of field marks that exist in the array
 o count(int)
Counts the number of value marks that exist in the array
 o count(int, int)
Counts the number of subvalue marks that exist in the array
 o count(int, int, int)
Counts the number of text marks that exist in the array
 o dcount()
Counts the number of fields that exist in the array, equivalent to count() + 1
 o dcount(int)
Counts the number of values that exist in the array at the given field position, equivalent to count( aField ) + 1
 o dcount(int, int)
Counts the number of subvalues that exist in the array at the given field,value position, equivalent to count( aFieldValue, aValue) + 1
 o dcount(int, int, int)
Counts the number of text values that exist in the array at the given field,value,subvalue position, equivalent to count() + 1
 o delete(int)
Deletes the given field value from the array
 o delete(int, int)
Deletes the given field/value value from the array
 o delete(int, int, int)
Deletes the given field/value/subvalue value from the array
 o extract(int)
Extracts a copy of the entire array
 o extract(int, int)
Extracts a copy of the requested field
 o extract(int, int, int)
Extracts a copy of the requested subvalue
 o insert(int, int, int, Object)
Inserts an Object into the dynamic array at the given field,value,subvalue position
 o insert(int, int, Object)
Inserts an Object into the dynamic array at the given field,value position
 o insert(int, Object)
Inserts an Object into the dynamic array at the given field position
 o length(int)
Returns the length of the entire dynamic array
 o length(int, int)
Returns the length of the given field,value of the dynamic array
 o length(int, int, int)
Returns the length of the given field,value,subvalue of the dynamic array
 o regenerateDynArray()
recreate the dynArray structure
 o remove(int)
Performs a delete on the given field, but also returns the deleted field
 o remove(int, int)
Performs a delete on the given field/value, but also returns the deleted value
 o remove(int, int, int)
Performs a delete on the given field/value/subvalue, but also returns the deleted subvalue
 o replace(int, int, int, Object)
Replaces the field/value/subvalue specified with the new data value
 o replace(int, int, Object)
Replaces the field/value specified with the new data value
 o replace(int, Object)
Replaces the field specified with the new data value
 o setValue(Object)
replaces the contents of the dynamic array with the given newValue param newValue a String object representing the dynamic array
 o setValue(String)
replaces the contents of the dynamic array with the given newValue param newValue a String object representing the dynamic array
 o toString()
Converts the given UniDynArray into a base String

Constructors

 o UniDynArray
 public UniDynArray()
Constructs a dynamic array with no characters in it

 o UniDynArray
 public UniDynArray(Object aString)
Constructs a dynamic array with the passed in Object value

Parameters:
aString - Object representing the data to be converted into a dynamic array
 o UniDynArray
 public UniDynArray(String aString)
Constructs a dynamic array with the passed in Object value

Parameters:
aString - Object representing the data to be converted into a dynamic array

Methods

 o count
 public int count(int aField,
                  int aValue,
                  int aSubValue)
Counts the number of text marks that exist in the array

Parameters:
aField - integer representing which field mark to count
aValue - integer representing the value position to count
aSubValue - integer representing which subvalue position to count
Returns:
integer representing the number of text mark characters in the array
 o count
 public int count(int aField,
                  int aValue)
Counts the number of subvalue marks that exist in the array

Parameters:
aField - integer representing which field mark to count
aValue - integer representing the value position to count
Returns:
integer representing the number of subvalue mark characters in the array
 o count
 public int count(int aField)
Counts the number of value marks that exist in the array

Parameters:
aField - integer representing which field mark to count
Returns:
integer representing the number of value mark characters in the array
 o count
 public int count()
Counts the number of field marks that exist in the array

Returns:
integer representing the number of field mark characters in the array
Overrides:
count in class UniString
 o dcount
 public int dcount(int aField,
                   int aValue,
                   int aSubValue)
Counts the number of text values that exist in the array at the given field,value,subvalue position, equivalent to count() + 1

Parameters:
aField - integer representing which field to count values for
aValue - integer representing which value to use
aSubValue - integer representing which subvalue to use
Returns:
integer representing the number of text values in the array
 o dcount
 public int dcount(int aField,
                   int aValue)
Counts the number of subvalues that exist in the array at the given field,value position, equivalent to count( aFieldValue, aValue) + 1

Parameters:
aField - integer representing which field to count values for
aValue - integer representing which value to count subvalues for
Returns:
integer representing the number of subvalue in the field/value of the array
 o dcount
 public int dcount(int aField)
Counts the number of values that exist in the array at the given field position, equivalent to count( aField ) + 1

Parameters:
aField - integer representing which field to count values for
Returns:
integer representing the number of value in the field of the array
 o dcount
 public int dcount()
Counts the number of fields that exist in the array, equivalent to count() + 1

Returns:
integer representing the number of fields in the array
Overrides:
dcount in class UniString
 o delete
 public void delete(int aField,
                    int aValue,
                    int aSubValue)
Deletes the given field/value/subvalue value from the array

Parameters:
aField - integer representing which field to delete
aValue - integer representing which value within the field to delete
aSubValue - integer representing which subvalue within the value to delete
 o delete
 public void delete(int aField,
                    int aValue)
Deletes the given field/value value from the array

Parameters:
aField - integer representing which field to delete
aValue - integer representing which value within the field to delete
 o delete
 public void delete(int aField)
Deletes the given field value from the array

Parameters:
aField - integer representing which field to delete
 o extract
 public UniDynArray extract(int aField,
                            int aValue,
                            int aSubValue)
Extracts a copy of the requested subvalue

Parameters:
aField - integer representing which field to extract
aValue - integer representing which value to extract
aSubValue - integer representing which subvalue to extract
Returns:
UniDynArray representing the requested subvalue
 o extract
 public UniDynArray extract(int aField,
                            int aValue)
Extracts a copy of the requested field

Parameters:
aField - integer representing which field to extract
aValue - integer representing which value to extract
Returns:
UniDynArray representing the requested field
 o extract
 public UniDynArray extract(int aField)
Extracts a copy of the entire array

Parameters:
aField - integer representing which field to extract
Returns:
UniDynArray representing the requested extraction
 o insert
 public void insert(int aField,
                    int aValue,
                    int aSubValue,
                    Object aString)
Inserts an Object into the dynamic array at the given field,value,subvalue position

Parameters:
aField - integer representing which field to insert data into
aValue - integer representing which value to insert data into
aSubValue - integer representing which subvalue to insert data into
aString - String representing the data to be inserted
 o insert
 public void insert(int aField,
                    int aValue,
                    Object aString)
Inserts an Object into the dynamic array at the given field,value position

Parameters:
aField - integer representing which field to insert data into
aValue - integer representing which value to insert data into
aString - String representing the data to be inserted
 o insert
 public void insert(int aField,
                    Object aString)
Inserts an Object into the dynamic array at the given field position

Parameters:
aField - integer representing which field to insert data into
aString - String representing the data to be inserted
Overrides:
insert in class UniString
 o length
 public int length(int aField,
                   int aValue,
                   int aSubValue)
Returns the length of the given field,value,subvalue of the dynamic array

Parameters:
aField - integer representing the field to obtain the length of
aValue - integer representing the value to get the length from
aSubValue - integer representing the subvalue to get the length from
Returns:
integer representing the length of the field,value,subvalue of the dynamic array
 o length
 public int length(int aField,
                   int aValue)
Returns the length of the given field,value of the dynamic array

Parameters:
aField - integer representing the field to obtain the length of
aValue - integer representing the value to get the length from
Returns:
integer representing the length of the field,value of the dynamic array
 o length
 public int length(int aField)
Returns the length of the entire dynamic array

Parameters:
aField - integer representing which field to insert data into
Returns:
integer representing the length of the dynamic array
 o remove
 public UniDynArray remove(int aField,
                           int aValue,
                           int aSubValue)
Performs a delete on the given field/value/subvalue, but also returns the deleted subvalue

Parameters:
aField - integer representing the field to remove
aValue - integer representing the value to remove
aSubValue - integer representing the subvalue to remove
Returns:
UniDynArray representing the deleted subvalue from the array
 o remove
 public UniDynArray remove(int aField,
                           int aValue)
Performs a delete on the given field/value, but also returns the deleted value

Parameters:
aField - integer representing the field to remove
aValue - integer representing the value to remove
Returns:
UniDynArray representing the deleted value from the array
 o remove
 public UniDynArray remove(int aField)
Performs a delete on the given field, but also returns the deleted field

Parameters:
aField - integer representing the field to remove
Returns:
UniDynArray representing the deleted field from the array
 o replace
 public void replace(int aField,
                     int aValue,
                     int aSubValue,
                     Object aString)
Replaces the field/value/subvalue specified with the new data value

Parameters:
aField - integer representing the field to replace
aValue - integer representing the value to replace
aSubValue - representing the subvalue to replace
aString - Object representing the new data value
 o replace
 public void replace(int aField,
                     int aValue,
                     Object aString)
Replaces the field/value specified with the new data value

Parameters:
aField - integer representing the field to replace
aValue - integer representing the value to replace
aString - Object representing the new data value
 o replace
 public void replace(int aField,
                     Object aString)
Replaces the field specified with the new data value

Parameters:
aField - integer representing the field to replace
aString - Object representing the new data value
 o setValue
 public void setValue(Object newValue)
replaces the contents of the dynamic array with the given newValue param newValue a String object representing the dynamic array

Overrides:
setValue in class UniString
 o setValue
 public void setValue(String newValue)
replaces the contents of the dynamic array with the given newValue param newValue a String object representing the dynamic array

Overrides:
setValue in class UniString
 o toString
 public String toString()
Converts the given UniDynArray into a base String

Returns:
a String object representing the dynamic array
Overrides:
toString in class UniString
 o regenerateDynArray
 protected void regenerateDynArray()
recreate the dynArray structure


All Packages  Class Hierarchy  This Package  Previous  Next  Index