public class IDataHelper
extends com.wm.data.IDataUtil
Instances of this class can also be created to wrap an IData object. Internally, IDataHelper instances will internally manage a single IDataCursor object and provide a set of utility functions to access IData field values.
Modifier and Type | Field and Description |
---|---|
com.wm.data.IDataCursor |
cursor
A single cursor object allocated to manipulate the wrapped IData object
|
protected boolean |
cursorAvailable
Indicates if a cursor has be created to work with the wrapped IData object.
|
com.wm.data.IData |
iData
The IData object wrapped by the helper instance
|
Constructor and Description |
---|
IDataHelper(com.wm.data.IData data)
Constructor to wrap an IData object with a set of utility function.
|
Modifier and Type | Method and Description |
---|---|
static void |
clear(com.wm.data.IDataCursor cursor)
Remove everything in the IData object referred to by the IDataCursor
|
static com.wm.data.IData |
cloneIData(com.wm.data.IData data)
To clone IData
|
void |
destroy()
Destroy the IDataHelper instance that is wrapper in IData object.
|
void |
finalize() |
java.lang.Object |
get(java.lang.String name)
Returns the first string value in the cursor keyed by 'name'
|
com.wm.data.IData |
getIData(java.lang.String name)
Returns the first IData value in the cursor keyed by 'name'
|
com.wm.data.IData[] |
getIDataArray(java.lang.String name)
Returns the first IData array value in the cursor keyed by 'name'
|
static java.lang.String |
getIDataStringBody(com.wm.data.IDataCursor cursor,
java.lang.String name)
Returns the *body string field in an IData subrecord
This represents text field data in an XML element containing
attributes.
|
int |
getInt(java.lang.String name,
int def)
Returns the first int value in the cursor keyed by 'name'
|
static java.lang.Object |
getNext(com.wm.data.IDataCursor cursor,
java.lang.String name)
Returns the next value in the cursor keyed by 'name'
|
java.lang.Object |
getNext(java.lang.String name)
Returns the next value in the IData keyed by 'name'
|
static com.wm.data.IData |
getNextIData(com.wm.data.IDataCursor cursor,
java.lang.String name)
Returns the next IData value in the cursor keyed by 'name'.
|
com.wm.data.IData |
getNextIData(java.lang.String name)
Returns the next IData value in the cursor keyed by 'name'
|
static com.wm.data.IData[] |
getNextIDataArray(com.wm.data.IDataCursor cursor,
java.lang.String name)
Returns the next IData array value in the cursor keyed by 'name'
|
com.wm.data.IData[] |
getNextIDataArray(java.lang.String name)
Returns the next IData array value in the cursor keyed by 'name'
|
static java.lang.String |
getNextString(com.wm.data.IDataCursor cursor,
java.lang.String name)
Returns the next string value in the cursor keyed by 'name'
|
java.lang.String |
getNextString(java.lang.String name)
Returns the next string value in the cursor keyed by 'name'
|
static java.lang.String[] |
getNextStringArray(com.wm.data.IDataCursor cursor,
java.lang.String name)
Returns the next string array value in the cursor keyed by 'name'
|
java.lang.String[] |
getNextStringArray(java.lang.String name)
Returns the next string array value in the cursor keyed by 'name'
|
java.lang.String |
getString(java.lang.String name)
Returns the first string value in the cursor keyed by 'name'
|
java.lang.String[] |
getStringArray(java.lang.String name)
Returns the first string array value in the cursor keyed by 'name'
|
static boolean |
isEmpty(com.wm.data.IDataCursor cursor)
Check if the IData object is empty
|
static boolean |
isFirstEqualTo(com.wm.data.IDataCursor cursor,
java.lang.String name,
java.lang.String value)
Returns true if the value of the first string field keyed by "name" is equal to "value"
|
boolean |
isFirstEqualTo(java.lang.String name,
java.lang.String value)
Returns true if the value of the first string field keyed by "name" is equal to "value"
|
static boolean |
isNextEqualTo(com.wm.data.IDataCursor cursor,
java.lang.String name,
java.lang.String value)
Returns true if the value of the next string field keyed by "name" is equal to "value"
|
boolean |
isNextEqualTo(java.lang.String name,
java.lang.String value)
Returns true if the value of the next string field keyed by "name" is equal to "value"
|
void |
put(java.lang.String name,
java.lang.Object val)
Add the name/value pair to the IData
|
java.util.Hashtable |
toHashtable()
Converts the wrapped IData object into a Hashtable
NOTE: some data may be lost in this transformation
If the IData Object contains more than one value
for the same key, the latest value for that key is
inserted into the Hashtable
|
static java.util.Hashtable |
toHashtable(com.wm.data.IData d)
Converts an IData Object into a Hashtable
NOTE: some data may be lost in this transformation
If the IData Object contains more than one value
for the same key, the latest value for that key is
inserted into the Hashtable
|
static com.wm.data.IData |
toIData(java.util.Hashtable h)
Converts a Hashtable into an IData Object
(using the Values implementation of an IData object)
|
com.wm.util.Values |
toValues()
Converts the wrapped IData object into a Values object.
|
static com.wm.util.Values |
toValues(com.wm.data.IData d)
Converts an IData object into a Values object.
|
static void |
unPositionCursor(com.wm.data.IDataCursor cursor)
Unposition a IDataCursor object so it no longer points to anything in the IData
NOTE: This is currently not implemented.
|
append, clone, contains, copy, create, deepClone, equals, get, getBoolean, getBoolean, getBoolean, getIData, getIData, getIDataArray, getInt, getInt, getInt, getLong, getNonEmptyString, getObjectArray, getString, getString, getStringArray, getStringArray, getStringTable, getStringTable, merge, put, putInt, remove, size, sortIDataArrayByKey, sortIDataArrayByKey
public com.wm.data.IDataCursor cursor
protected boolean cursorAvailable
public com.wm.data.IData iData
public IDataHelper(com.wm.data.IData data)
data
- IData object to wrap.public static void clear(com.wm.data.IDataCursor cursor)
cursor
- IDataCursor to the underlying IData objectpublic static com.wm.data.IData cloneIData(com.wm.data.IData data)
data
- public void destroy()
public void finalize()
finalize
in class java.lang.Object
public java.lang.Object get(java.lang.String name)
name
- The name of the field to search for.public com.wm.data.IData getIData(java.lang.String name)
name
- The name of the field to search for.public com.wm.data.IData[] getIDataArray(java.lang.String name)
name
- The name of the field to search for.public static java.lang.String getIDataStringBody(com.wm.data.IDataCursor cursor, java.lang.String name)
cursor
- IDataCursor referring to the IDataObjectname
- the name of the IData subrecord that contains a *body field.public int getInt(java.lang.String name, int def)
name
- The name of the field to search for.public static java.lang.Object getNext(com.wm.data.IDataCursor cursor, java.lang.String name)
cursor
- IDataCursor to the underlying IData objectname
- The key to search forpublic java.lang.Object getNext(java.lang.String name)
name
- The name of the field to search for.public static com.wm.data.IData getNextIData(com.wm.data.IDataCursor cursor, java.lang.String name)
cursor
- IDataCursor to the underlying IData objectname
- The key to search forpublic com.wm.data.IData getNextIData(java.lang.String name)
name
- The name of the field to search for.public static com.wm.data.IData[] getNextIDataArray(com.wm.data.IDataCursor cursor, java.lang.String name)
cursor
- IDataCursor to the underlying IData objectname
- The key to search forpublic com.wm.data.IData[] getNextIDataArray(java.lang.String name)
name
- The name of the field to search for.public static java.lang.String getNextString(com.wm.data.IDataCursor cursor, java.lang.String name)
cursor
- IDataCursor to the underlying IData objectname
- The key to search forpublic java.lang.String getNextString(java.lang.String name)
name
- The name of the field to search for.public static java.lang.String[] getNextStringArray(com.wm.data.IDataCursor cursor, java.lang.String name)
cursor
- IDataCursor to the underlying IData objectname
- The key to search forpublic java.lang.String[] getNextStringArray(java.lang.String name)
name
- The name of the field to search for.public java.lang.String getString(java.lang.String name)
name
- The name of the field to search for.public java.lang.String[] getStringArray(java.lang.String name)
name
- The name of the field to search for.public static boolean isEmpty(com.wm.data.IDataCursor cursor)
cursor
- IDataCursor to the underlying IData objectpublic static boolean isFirstEqualTo(com.wm.data.IDataCursor cursor, java.lang.String name, java.lang.String value)
cursor
- IDataCursor to the underlying IData objectname
- The key to search for.value
- The value to compare withpublic boolean isFirstEqualTo(java.lang.String name, java.lang.String value)
name
- The key to search for.value
- The value to compare withpublic static boolean isNextEqualTo(com.wm.data.IDataCursor cursor, java.lang.String name, java.lang.String value)
cursor
- IDataCursor to the underlying IData objectname
- The key to search for.value
- The value to compare withpublic boolean isNextEqualTo(java.lang.String name, java.lang.String value)
cursor
- IDataCursor to the underlying IData objectname
- The key to search for.value
- The value to compare withpublic void put(java.lang.String name, java.lang.Object val)
name
- The name of the field to search for.value
- The value of the field.public java.util.Hashtable toHashtable()
public static java.util.Hashtable toHashtable(com.wm.data.IData d)
d
- IData to convert.public static com.wm.data.IData toIData(java.util.Hashtable h)
h
- Hashtable to convertpublic com.wm.util.Values toValues()
public static com.wm.util.Values toValues(com.wm.data.IData d)
d
- IData to convert.public static void unPositionCursor(com.wm.data.IDataCursor cursor)
cursor
- IDataCursor to unposition
Copyright © 2003 - 2021 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.