Skip navigation links

oracle.alm.connector.data
Class DataSourceDef

java.lang.Object
oracle.alm.connector.data.DataSourceDef

public class DataSourceDef

extends java.lang.Object

The DataSourceDef defines a data source for a work item field. It is the run time data structure for the DataSource tag used in the connector model meta data XML file.

Since:

11.1.1.1.0

See Also:

WorkItemDef

Field Summary

static java.lang.String

DYNAMIC_WIFIELDS_DATASOURCE

Constructor Summary

DataSourceDef(java.lang.String name)
Constructs a data source with the specified name.

Method Summary

void	AddCriteria(java.lang.String name, WorkItemQuery criteria) Adds a query object to the data source.
WorkItemQuery	getCriteria(java.lang.String name) Retrieves a query criteria from the data source.
java.util.Map<java.lang.String,WorkItemFieldDef>	getFieldDefs() Retrieves all field definitions created based on the model XML data
java.lang.String	getIdDef() Retrieves the id used to uniquely identify a row of data record
java.lang.String	getName() Retrieves the data source name.
void	setFieldDef(WorkItemFieldDef fieldDef) Add a field definition for the data source.
void	setIdDef(java.lang.String idDef) Sets the id definition for ensuring unique row key for each row data in the data source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DYNAMIC_WIFIELDS_DATASOURCE

public static final java.lang.String DYNAMIC_WIFIELDS_DATASOURCE

See Also:

Constant Field Values

Constructor Detail

DataSourceDef

public DataSourceDef(java.lang.String name)

Constructs a data source with the specified name.

Parameters:

name - the name given to the data source object.

Method Detail

getName

public java.lang.String getName()

Retrieves the data source name.

Returns:

the name of the data source.

setIdDef

public void setIdDef(java.lang.String idDef)

Sets the id definition for ensuring unique row key for each row data in the data source.

Parameters:

idDef - an field name used to uniquely identify a row of data record in the data source.

getIdDef

public java.lang.String getIdDef()

Retrieves the id used to uniquely identify a row of data record

Returns:

the id used to uniquely identify a row of data record

getFieldDefs

public java.util.Map<java.lang.String,WorkItemFieldDef> getFieldDefs()

Retrieves all field definitions created based on the model XML data

Returns:

all fields of the data source as a <field name, field definition object > map.

getCriteria

public WorkItemQuery getCriteria(java.lang.String name)

Retrieves a query criteria from the data source.

Parameters:

name - criteria name.

Returns:

return the criteria identified by the specified criteria name.

setFieldDef

public void setFieldDef(WorkItemFieldDef fieldDef)

Add a field definition for the data source.

Parameters:

fieldDef - WorkItemFieldDef object that contains an item field definition based on model XML.

AddCriteria

public void AddCriteria(java.lang.String name,
                        WorkItemQuery criteria)

Adds a query object to the data source.

Parameters:

name - criteria name

criteria - a criteria

Skip navigation links