DhTabularDataSource Class

DhTabularDataSource Class

This Package | All Packages

DhObjectFactory
  |
  +--DhObjectDataSource
    |
    +--DhTabularDataSource
public class DhTabularDataSource
extends DhObjectDataSource

Encapsulates the Microsoft Tabular Data Control (TDC). This control allows access to data that is stored in a delimited text file. For more information, see your Internet SDK documentation.

Constructors
Name Description
DhTabularDataSource() Constructs a DhTabularDataSource object.
DhTabularDataSource( String strUrl ) Constructs a DhTabularDataSource object.

Methods
Name Description
getCaseSensitive() Retrieves the current case-sensitivity setting for sorting.
getDataUrl( ) Retrieves the current URL setting for retrieving a data file.
getEscapeChar() Retrieves the current escape character.
getFieldDelim() Retrieves the current field delimiter character or characters.
getFilter() Retrieves the current data filter string.
getRowDelim() Retrieves the current row delimiter character or characters.
getSortColumns( ) Retrieves the current column sort setting string.
getTextQualifier() Retrieves the current text qualifier character.
getUseHeader() Retrieves the current header-row setting.
reset() Queries the data again based on the new control settings.
setCaseSensitive( boolean fCaseSensitive ) Sets case sensitivity in sorting.
setDataUrl( String strUrl ) Sets the URL for retrieving the file data in a standard format, such as http:, file:, ftp:, and so on.
setEscapeChar( char c ) Specifies the character used to escape special characters.
setFieldDelim( String fd ) Sets the field delimiter character or characters.
setFilter( String strFilter ) Sets the filter for the data display, and then queries for the data again.
setRowDelim( String rd ) Sets the row delimiter character(s).
setSortColumns( String strSort ) Sets the column or columns to be sorted in ascending or descending order.
setTextQualifier( char c ) Specifies a single character used to surround fields that can include special characters such as new lines, tabs, or commas.
setUseHeader( boolean fUseHeader ) Specifies whether the first row of the data contains header information.

Constructors

DhTabularDataSource.DhTabularDataSource

Syntax 1
public DhTabularDataSource();
Description

Constructs a DhTabularDataSource object.



Syntax 2
public DhTabularDataSource( String strUrl );
Parameters
strUrl
Specifies the initial dataUrl to reference.
Description

Constructs a DhTabularDataSource object.

See Also
setDataUrl

Methods

DhTabularDataSource.getCaseSensitive

Syntax
public boolean getCaseSensitive();
Return Value

Returns true to sort by case; otherwise, returns false.

Description

Retrieves the current case-sensitivity setting for sorting.

DhTabularDataSource.getDataUrl

Syntax
public String getDataUrl( );
Return Value

Returns the dataURL of the file.

Description

Retrieves the current URL setting for retrieving a data file.

See Also
setDataUrl

DhTabularDataSource.getEscapeChar

Syntax
public char getEscapeChar();
Return Value

Returns the escape character.

Description

Retrieves the current escape character. The default is none.

DhTabularDataSource.getFieldDelim

Syntax
public String getFieldDelim();
Return Value

Returns the field delimiter character sequence.

Description

Retrieves the current field delimiter character or characters.

DhTabularDataSource.getFilter

Syntax
public String getFilter();
Return Value

Returns the data filter.

Description

Retrieves the current data filter string.

See Also
setDataFilter

DhTabularDataSource.getRowDelim

Syntax
public String getRowDelim();
Return Value

Returns the row delimiter character sequence.

Description

Retrieves the current row delimiter character or characters.

DhTabularDataSource.getSortColumns

Syntax
public String getSortColumns( );
Return Value

Returns the current sort string.

Description

Retrieves the current column sort setting string.

See Also
setSortColumns

DhTabularDataSource.getTextQualifier

Syntax
public char getTextQualifier();
Return Value

Returns the current text qualifier character.

Description

Retrieves the current text qualifier character. The default is the double quotation mark (").

DhTabularDataSource.getUseHeader

Syntax
public boolean getUseHeader();
Return Value

Returns true if first the line of data contains header information, or returns false if it does not.

Description

Retrieves the current header-row setting.

See Also
setUseHeader()

DhTabularDataSource.reset

Syntax
public void reset();
Description

Queries the data again based on the new control settings.

DhTabularDataSource.setCaseSensitive

Syntax
public void setCaseSensitive( boolean fCaseSensitive );
Parameters
fCaseSensitive
Set to true to sort with case sensitivity; set to false to ignore case.
Description

Sets case sensitivity in sorting.

DhTabularDataSource.setDataUrl

Syntax
public void setDataUrl( String strUrl );
Parameters
strUrl
The URL of the data file.
Description

Sets the URL for retrieving the file data in a standard format, such as http:, file:, ftp:, and so on.

Note: This URL must be in the same security zone as the document that loaded the control.

DhTabularDataSource.setEscapeChar

Syntax
public void setEscapeChar( char c );
Parameters
c
The escape character.
Description

Specifies the character used to escape special characters. The default is none.

DhTabularDataSource.setFieldDelim

Syntax
public void setFieldDelim( String fd );
Parameters
fd
The new field delimiter character or sequence.
Description

Sets the field delimiter character or characters. The default is a comma (,).

DhTabularDataSource.setFilter

Syntax
public void setFilter( String strFilter );
Parameters
strFilter
The new data filter; for example, "PhoneNum <> '9*'" or "(Quantity > 10 & color = 'lime') | Quantity < 5".
Description

Sets the filter for the data display, and then queries for the data again.

DhTabularDataSource.setRowDelim

Syntax
public void setRowDelim( String rd );
Parameters
rd
The new row delimiter character or sequence.
Description

Sets the row delimiter character(s). The default is the newline character.

DhTabularDataSource.setSortColumns

Syntax
public void setSortColumns( String strSort );
Parameters
strSort
The sort description string.
Description

Sets the column or columns to be sorted in ascending or descending order. The following example sorts the "ProductName" column ascending, followed by the "Price" column descending:

ProductName; -Price 

DhTabularDataSource.setTextQualifier

Syntax
public void setTextQualifier( char c );
Parameters
c
The text qualifier character.
Description

Specifies a single character used to surround fields that can include special characters such as new lines, tabs, or commas. These characters can also be active as field or row delimiters. The default value is the double quotation mark (").

DhTabularDataSource.setUseHeader

Syntax
public void setUseHeader( boolean fUseHeader );
Parameters
fUseHeader
Set to true if first row contains header information; set to false if it does not.
Description

Specifies whether the first row of the data contains header information.