All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class nsjava.NsSet 

java.lang.Object
   |
   +----nsjava.NsSet
public class NsSet
extends Object

NsSet provides a wrapper around the aolserver ns_set structures.

See Also:
NsDb, NsLog, NsPg, NsTcl

Constructor Index

o NsSet()
Create and instance of an NsSet object.
o NsSet(String)
Create and instance of an NsSet object.

Method Index

o copy()
Create a new Ns_Set object.
o cput(String, String)
put the new value in the set if the key doesn't exist already.
o create(String)
Init the NsSet object.
o delete(int)
Delete the entry corresponding to the specified index.
o delete(Integer)
Delete the entry corresponding to the specified index.
o finalize()
Frees the NsSet object.
o find(String)
Find the index corresponding to the specified key.
o free()
Free the NsSet structure.
o get(String)
Get the entry corresponding to the specified key.
o getPointer()
Get the Ns_Set reference pointer
o icput(String, String)
put the new value in the set if the key doesn't exist already(ignore case)
o idelkey(String)
Delete the entry corresponding to the specified key (ignore case).
o ifind(String)
Find the index corresponding to the specified key (ignore case).
o iget(String)
Get the entry corresponding to the specified key (ignore case).
o isnull(int)
Is the value corresponding to the specified index null?
o isnull(Integer)
Is the value corresponding to the specified index null?
o iunique(String)
Is the key unique within this NsSet(ignore case)?
o key(int)
The key of the corresponding index.
o key(Integer)
The key of the corresponding index.
o merge(NsSet)
merge another set with this one.
o move(NsSet)
move another set to this one.
o name()
Get the name of the NsSet object.
o print()
Print the NsSet structure.
o put(String, String)
append the new value in the set.
o size()
Get the number of entries in the NsSet object.
o split()
split an NsSet object - not yet implemented.
o truncate(int)
Truncate the NsSet structure.
o truncate(Integer)
Truncate the NsSet structure.
o unique(String)
Is the key unique within this NsSet?
o update(String, String)
update the entry corresponding to the key.
o value(int)
Get the value corresponding to the specified index.
o value(Integer)
Get the value corresponding to the specified index.

Constructors

o NsSet 
 public NsSet()
Create and instance of an NsSet object.

Returns:
an NsSet instance.
o NsSet 
 public NsSet(String ptr)
Create and instance of an NsSet object.

Parameters:
ptr - reference to Ns_Set structure.
Returns:
an NsSet instance.

Methods

o getPointer 
 public String getPointer()
Get the Ns_Set reference pointer

Parameters:
ptr - reference to Ns_Set structure.
Returns:
an NsSet instance.
o finalize 
 public void finalize()
Frees the NsSet object.

Overrides:
finalize in class Object
o create 
 public void create(String name)
Init the NsSet object.

Parameters:
name - of the NsSet structure.
o copy 
 public NsSet copy()
Create a new Ns_Set object.

Returns:
new NsSet instance.
o split 
 public NsSet split() throws NoSuchMethodException
split an NsSet object - not yet implemented.

Returns:
new NsSet instance.
Throws: NoSuchMethodException
for any calls to this method.
o size 
 public Integer size()
Get the number of entries in the NsSet object.

Returns:
the number of entries.
o name 
 public String name()
Get the name of the NsSet object.

Returns:
the name.
o print 
 public void print()
Print the NsSet structure.

o free 
 public void free()
Free the NsSet structure.

o find 
 public Integer find(String key)
Find the index corresponding to the specified key.

Parameters:
key - the key name.
Returns:
the index.
o get 
 public String get(String key)
Get the entry corresponding to the specified key.

Parameters:
key - the key name.
Returns:
the value.
o unique 
 public boolean unique(String key)
Is the key unique within this NsSet?

Parameters:
key - the key name.
Returns:
true/false
o ifind 
 public Integer ifind(String key)
Find the index corresponding to the specified key (ignore case).

Parameters:
key - the key name.
Returns:
the index.
o iget 
 public String iget(String key)
Get the entry corresponding to the specified key (ignore case).

Parameters:
key - the key name.
Returns:
the value.
o idelkey 
 public void idelkey(String key)
Delete the entry corresponding to the specified key (ignore case).

Parameters:
key - the key name.
o iunique 
 public boolean iunique(String key)
Is the key unique within this NsSet(ignore case)?

Parameters:
key - the key name.
Returns:
true/false
o value 
 public String value(int index)
Get the value corresponding to the specified index.

Parameters:
index - the index of the value.
Returns:
the value.
o value 
 public String value(Integer index)
Get the value corresponding to the specified index.

Parameters:
index - the index of the value.
Returns:
the value.
o isnull 
 public boolean isnull(int index)
Is the value corresponding to the specified index null?

Parameters:
index - the index of the value.
Returns:
true/false
o isnull 
 public boolean isnull(Integer index)
Is the value corresponding to the specified index null?

Parameters:
index - the index of the value.
Returns:
true/false
o key 
 public String key(int index)
The key of the corresponding index.

Parameters:
idx - the index of the value.
Returns:
the key
o key 
 public String key(Integer index)
The key of the corresponding index.

Parameters:
idx - the index of the value.
Returns:
the key
o delete 
 public void delete(int index)
Delete the entry corresponding to the specified index.

Parameters:
index - the key name.
o delete 
 public void delete(Integer index)
Delete the entry corresponding to the specified index.

Parameters:
index - the key name.
o truncate 
 public void truncate(int index)
Truncate the NsSet structure.

Parameters:
index - index of the last entry.
o truncate 
 public void truncate(Integer index)
Truncate the NsSet structure.

Parameters:
index - index of the last entry.
o update 
 public Integer update(String key,
                       String val)
update the entry corresponding to the key.

Parameters:
key - the key
val - the value
Returns:
index of updated entry.
o icput 
 public Integer icput(String key,
                      String val)
put the new value in the set if the key doesn't exist already(ignore case)

Parameters:
key - the key
val - the value
Returns:
index of updated entry.
o cput 
 public Integer cput(String key,
                     String val)
put the new value in the set if the key doesn't exist already.

Parameters:
key - the key
val - the value
Returns:
index of updated entry.
o put 
 public Integer put(String key,
                    String val)
append the new value in the set.

Parameters:
key - the key
val - the value
Returns:
index of updated entry.
o merge 
 public void merge(NsSet low)
merge another set with this one.

Parameters:
low - pointer to the other Ns_Set structure.
o move 
 public void move(NsSet from)
move another set to this one.

Parameters:
from - the other Ns_Set structure. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index