DataRecordSet
Inheritance: java.lang.Object
public class DataRecordSet
Stores, formats, refreshes, and exposes data queried from a database in Microsoft Visio.
Constructors
| Constructor | Description |
|---|---|
| DataRecordSet() | Constructor. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getADOData() | Contains XML that conforms to the ADO classic XML schema for an ADO recordset and that describes the data in the data recordset. |
| getAutoLinkComparison() | Defines a rule that compares a column in the parent DataRecordset element with a shape data item from the last successful automatic linking action performed in the user interface. |
| getChecksum() | A checksum value, generated by Visio, and based on data-recordset properties. |
| getClass() | |
| getCommand() | The command string used to query data from the data source. |
| getConnectionID() | The connection ID for the associated DataConnection object. |
| getDataColumns() | Contains all the DataColumn elements in a data recordset. |
| getID() | The data recordset ID, unique within the document. |
| getName() | The display (or “friendly”) name of the data recordset. |
| getNextRowID() | The next available Visio row ID. |
| getOptions() | Options to apply to the data recordset. |
| getPrimaryKeys() | Identifies one or more primary-key columns in the data recordset. |
| getRefreshConflicts() | Indicates a row in the data recordset linked to a shape that is in conflict after the data recordset is refreshed. |
| getRefreshInterval() | How often (in minutes) Visio refreshes the data recordset automatically. |
| getRefreshNoReconciliationUI() | Whether the data-reconciliation user interface should be disabled. |
| getRefreshOverwriteAll() | Whether to overwrite user changes to shape data items in shapes linked to data when the data recordset is refreshed. |
| getReplaceLinks() | Defines how shape-data links are treated when shapes are copied or cut. 1 to replace existing links in the target shape. 0 to maintain existing links in the target shape. |
| getRowMaps() | Maps a data-recordset row to a shape. |
| getRowOrder() | Whether to use the order of the rows in the data recordset as the primary key. |
| getTimeRefreshed() | The date and time the data recordset was last refreshed. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| refresh(int connectionType) | Executes the query string associated with the connected (non-XML-based) DataRecordset and updates linked shapes with new data from the data source returned by the query. |
| setADOData(String value) | For the description of this property, please see getADOData() |
| setChecksum(long value) | For the description of this property, please see {@link DataRecordSet#(getChecksum() & 0xFFFFFFFFL)} |
| setCommand(String value) | For the description of this property, please see getCommand() |
| setConnectionID(long value) | For the description of this property, please see {@link DataRecordSet#(getConnectionID() & 0xFFFFFFFFL)} |
| setID(long value) | For the description of this property, please see {@link DataRecordSet#(getID() & 0xFFFFFFFFL)} |
| setName(String value) | For the description of this property, please see getName() |
| setNextRowID(long value) | For the description of this property, please see {@link DataRecordSet#(getNextRowID() & 0xFFFFFFFFL)} |
| setOptions(int value) | For the description of this property, please see getOptions() |
| setRefreshInterval(long value) | For the description of this property, please see {@link DataRecordSet#(getRefreshInterval() & 0xFFFFFFFFL)} |
| setRefreshNoReconciliationUI(int value) | For the description of this property, please see getRefreshNoReconciliationUI() |
| setRefreshOverwriteAll(int value) | For the description of this property, please see getRefreshOverwriteAll() |
| setReplaceLinks(int value) | For the description of this property, please see getReplaceLinks() |
| setRowOrder(int value) | For the description of this property, please see getRowOrder() |
| setTimeRefreshed(DateTime value) | For the description of this property, please see getTimeRefreshed() |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
DataRecordSet()
public DataRecordSet()
Constructor.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getADOData()
public String getADOData()
Contains XML that conforms to the ADO classic XML schema for an ADO recordset and that describes the data in the data recordset.
Returns: java.lang.String
getAutoLinkComparison()
public AutoLinkComparison getAutoLinkComparison()
Defines a rule that compares a column in the parent DataRecordset element with a shape data item from the last successful automatic linking action performed in the user interface.
Returns: AutoLinkComparison
getChecksum()
public long getChecksum()
A checksum value, generated by Visio, and based on data-recordset properties. Set this attribute to 0; Visio recalculates this value at runtime.
Returns: long
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCommand()
public String getCommand()
The command string used to query data from the data source.
Returns: java.lang.String
getConnectionID()
public long getConnectionID()
The connection ID for the associated DataConnection object. Does not exist for XML data sources.
Returns: long
getDataColumns()
public DataColumnCollection getDataColumns()
Contains all the DataColumn elements in a data recordset.
Returns: DataColumnCollection
getID()
public long getID()
The data recordset ID, unique within the document.
Returns: long
getName()
public String getName()
The display (or “friendly”) name of the data recordset.
Returns: java.lang.String
getNextRowID()
public long getNextRowID()
The next available Visio row ID.
Returns: long
getOptions()
public int getOptions()
Options to apply to the data recordset. Possible values can be any combination of one or more of those shown in the following table.
Returns: int
getPrimaryKeys()
public ArrayList<String> getPrimaryKeys()
Identifies one or more primary-key columns in the data recordset.
Returns: java.util.ArrayList<java.lang.String>
getRefreshConflicts()
public RowCollection getRefreshConflicts()
Indicates a row in the data recordset linked to a shape that is in conflict after the data recordset is refreshed. RowID - Indicates a row in the data recordset linked to a shape that is in conflict after the data recordset is refreshed. ShapeID - Shape ID of the shape involved in the conflict. PageID - Page ID of the shape involved in the conflict.
Returns: RowCollection
getRefreshInterval()
public long getRefreshInterval()
How often (in minutes) Visio refreshes the data recordset automatically. This value must be 1 or larger.
Returns: long
getRefreshNoReconciliationUI()
public int getRefreshNoReconciliationUI()
Whether the data-reconciliation user interface should be disabled. True (1) to disable the user interface (UI). False (0) to enable the UI.
Returns: int
getRefreshOverwriteAll()
public int getRefreshOverwriteAll()
Whether to overwrite user changes to shape data items in shapes linked to data when the data recordset is refreshed.
Returns: int
getReplaceLinks()
public int getReplaceLinks()
Defines how shape-data links are treated when shapes are copied or cut. 1 to replace existing links in the target shape. 0 to maintain existing links in the target shape. If this attribute is absent, Visio asks the user whether to replace links on copy or cut.
Returns: int
getRowMaps()
public RowCollection getRowMaps()
Maps a data-recordset row to a shape. RowID - Row ID of the row, unique within the data recordset. ShapeID - Shape ID of the shape linked to data in the data-recordset row identified by RowID. PageID - Page ID of the shape linked to data in the data-recordset row identified by RowID.
Returns: RowCollection
getRowOrder()
public int getRowOrder()
Whether to use the order of the rows in the data recordset as the primary key. True (1) if row IDs are determined by row order. False (0) if row IDs are determined by values in the primary key column(s) of the data recordset.
Returns: int
getTimeRefreshed()
public DateTime getTimeRefreshed()
The date and time the data recordset was last refreshed.
Returns: DateTime
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
refresh(int connectionType)
public void refresh(int connectionType)
Executes the query string associated with the connected (non-XML-based) DataRecordset and updates linked shapes with new data from the data source returned by the query.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| connectionType | int | The type of provider which will be used for connectionAspose.Diagram.Manipulation.DataConnectionType. |
setADOData(String value)
public void setADOData(String value)
For the description of this property, please see getADOData()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setChecksum(long value)
public void setChecksum(long value)
For the description of this property, please see {@link DataRecordSet#(getChecksum() & 0xFFFFFFFFL)}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |
setCommand(String value)
public void setCommand(String value)
For the description of this property, please see getCommand()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setConnectionID(long value)
public void setConnectionID(long value)
For the description of this property, please see {@link DataRecordSet#(getConnectionID() & 0xFFFFFFFFL)}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |
setID(long value)
public void setID(long value)
For the description of this property, please see {@link DataRecordSet#(getID() & 0xFFFFFFFFL)}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |
setName(String value)
public void setName(String value)
For the description of this property, please see getName()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setNextRowID(long value)
public void setNextRowID(long value)
For the description of this property, please see {@link DataRecordSet#(getNextRowID() & 0xFFFFFFFFL)}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |
setOptions(int value)
public void setOptions(int value)
For the description of this property, please see getOptions()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setRefreshInterval(long value)
public void setRefreshInterval(long value)
For the description of this property, please see {@link DataRecordSet#(getRefreshInterval() & 0xFFFFFFFFL)}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | long |
setRefreshNoReconciliationUI(int value)
public void setRefreshNoReconciliationUI(int value)
For the description of this property, please see getRefreshNoReconciliationUI()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setRefreshOverwriteAll(int value)
public void setRefreshOverwriteAll(int value)
For the description of this property, please see getRefreshOverwriteAll()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setReplaceLinks(int value)
public void setReplaceLinks(int value)
For the description of this property, please see getReplaceLinks()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setRowOrder(int value)
public void setRowOrder(int value)
For the description of this property, please see getRowOrder()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setTimeRefreshed(DateTime value)
public void setTimeRefreshed(DateTime value)
For the description of this property, please see getTimeRefreshed()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |