Class Event.RowMetaData
Represents a meta data object describing a database table row
Defined in: </home/ubuntu/streamscape/NeeveBuild/stjsapi/src/main/webapp/js/event/RowMetaData.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Event.RowMetaData(capacity)
Creates a new meta data object describing a database table row
|
Method Attributes | Method Name and Description |
---|---|
void |
addColumn(name)
Adds a new column with the specified name to the row
|
void |
addColumn_(name, sqlType)
Adds a new column with the specified name and class to the row
|
void |
addColumn__(name, sqlType, nullable)
Adds a new column with the specified name, class and nullable flag to the row
|
Event.RowMetaData |
clone()
Returns a copy of this meta data
|
void |
enableRowId(useRID)
Enables Row Id usage.
|
number |
findColumn(columnName)
Returns the index in the row of the column with the specified name.
|
number |
Returns the current capacity of the row
|
number |
Returns the column count.
|
Event.ColumnDescriptor |
getColumnDescriptor(index)
Returns a column descriptor for the specified column.
|
Event.ColumnDescriptor |
Returns a column descriptor for the specified column name.
|
String |
getColumnName(index)
Returns the name of the column with the specified index.
|
String |
Returns an array of column names
|
String |
getColumnSQLType(index)
Returns the SQL type of the column at the specified index
|
String |
getColumnSQLTypeByName(name)
Returns the SQL type of the column with the specified name
|
String |
getColumnTypeClass(index)
Returns the java class name of the column at the specified index
|
String |
getColumnTypeClassByName(name)
Returns the java class name of the column with the specified name
|
boolean |
Returns if this meta data contains a return code
|
number |
Returns the key indices.
|
number |
Returns the number of the output parameters
|
String |
Returns the names of the output parameters
|
boolean |
Returns
true if the array has Row Id indexing enabled. |
void |
removeColumn(name)
Removes the column with the specified name from the row
|
void |
setCapacity(capacity)
Sets the specified capacity limit for the row
|
void |
setHasReturnCode(hasReturnCode)
Sets the flag indicating if this meta data contains a return code
|
void |
setKeyColumnsIndices(keyIndices)
Sets the key indices.
|
void |
setOutParameterNames(outParams)
Sets the names of the output parameters
|
Class Detail
Event.RowMetaData(capacity)
Creates a new meta data object describing a database table row
- Parameters:
- {number} capacity
- A capacity limit of the row
Method Detail
addColumn(name)
Adds a new column with the specified name to the row
- Parameters:
- {String} name
- The name for a new column
addColumn_(name, sqlType)
Adds a new column with the specified name and class to the row
- Parameters:
- {String} name
- The name of a new column
- {String} sqlType
- The SQL type of a new column
addColumn__(name, sqlType, nullable)
Adds a new column with the specified name, class and nullable flag to the row
- Parameters:
- {String} name
- The name for a new column
- {String} sqlType
- The SQL type of a new column
- {boolean} nullable
- A flag indicating if the created column can contain null values
{Event.RowMetaData}
clone()
Returns a copy of this meta data
- Returns:
- The meta data copy
enableRowId(useRID)
Enables Row Id usage. When enabled the array rows will contain
row_id
in the first position as uniqueley generated key. This value may be used as the
searchable key column. Additionally further calls to #getKeyColumnIndex() will
always return -2
, to indicate that a Row Id is defined. This method
overrides any key settings that may have been enabled by #setKeyColumnIndex.
- Parameters:
- {boolean} useRID
- Indicates if row id should be enabled or not
{number}
findColumn(columnName)
Returns the index in the row of the column with the specified name.
- Parameters:
- {String} columnName
- The name of the column to be found
- Returns:
- The index of the column with the specified name
{number}
getCapacity()
Returns the current capacity of the row
- Returns:
- The row capacity
{number}
getColumnCount()
Returns the column count.
-1 is returned if meta data is not initialized and 0 if it has no columns.
- Returns:
- The number of columns in the row
{Event.ColumnDescriptor}
getColumnDescriptor(index)
Returns a column descriptor for the specified column.
- Parameters:
- {number} index
- The index of the column to be found (starting from 1)
- Returns:
- A column descriptor of the specified column
{Event.ColumnDescriptor}
getColumnDescriptorByName(name)
Returns a column descriptor for the specified column name.
- Parameters:
- {String} name
- The name of the column to be found
- Returns:
- A column descriptor of the specified column
{String}
getColumnName(index)
Returns the name of the column with the specified index.
- Parameters:
- {number} index
- The index of the column to be found starting from 1
- Returns:
- The name of the column
{String[]}
getColumnNames()
Returns an array of column names
- Returns:
- A column names array
{String}
getColumnSQLType(index)
Returns the SQL type of the column at the specified index
- Parameters:
- {number} index
- The index of the column starting from 1
- Returns:
- The column SQL type
{String}
getColumnSQLTypeByName(name)
Returns the SQL type of the column with the specified name
- Parameters:
- {String} name
- The name of the column
- Returns:
- The column SQL type
{String}
getColumnTypeClass(index)
Returns the java class name of the column at the specified index
- Parameters:
- {number} index
- The index of the column starting from 1
- Returns:
- The column java class
{String}
getColumnTypeClassByName(name)
Returns the java class name of the column with the specified name
- Parameters:
- {String} name
- The name of the column
- Returns:
- The column java class
{boolean}
getHasReturnCode()
Returns if this meta data contains a return code
- Returns:
- if this meta data contains a return code
{number[]}
getKeyColumnsIndices()
Returns the key indices.
- Returns:
- The key indices
{number}
getOutParameterCount()
Returns the number of the output parameters
- Returns:
- The output parameters number
{String[]}
getOutParameterNames()
Returns the names of the output parameters
- Returns:
- The names of the output parameters
{boolean}
isRowIdEnabled()
Returns
true
if the array has Row Id indexing enabled.
- Returns:
- If the array has Row Id indexing enabled or not
removeColumn(name)
Removes the column with the specified name from the row
- Parameters:
- {String} name
- The name for the column to be removed
setCapacity(capacity)
Sets the specified capacity limit for the row
- Parameters:
- {number} capacity
- A new capacity limit to be set for the row
setHasReturnCode(hasReturnCode)
Sets the flag indicating if this meta data contains a return code
- Parameters:
- {boolean} hasReturnCode
- A flag indicating if this meta data contains a return code
setKeyColumnsIndices(keyIndices)
Sets the key indices.
- Parameters:
- {number[]} keyIndices
- The key indices
setOutParameterNames(outParams)
Sets the names of the output parameters
- Parameters:
- {String[]} outParams
- The output parameters names to be set