CkCsv Java Reference Documentation

CkCsv

Object Creation

CkCsv obj = new CkCsv();

Properties

boolean get_AutoTrim();
void put_AutoTrim(boolean newVal);

If true, then the strings returned by GetCell and GetCellByName are auto-trimmed of whitespace from both ends.

boolean get_Crlf();
void put_Crlf(boolean newVal);

If true, then CRLF line endings are used when saving the CSV to a file or to a string (i.e. for the methods SaveFile, SaveFile2, SaveToString). If false then bare LF line-endings are used.

void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

void get_Delimiter(CkString str);
String delimiter();
void put_Delimiter(String newVal);

The character that separates fields in a record. It is a comma by default. If the Delimiter property is not explicitly set, the CSV component will detect the delimiter when loading a CSV. (Semicolons are typically used in locales where the comma is used as a decimal point.)

boolean get_HasColumnNames();
void put_HasColumnNames(boolean newVal);

Set to true prior to loading a CSV if the 1st record contains column names. This allows the CSV parser to correctly load the column names and not treat them as data.

void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastErrorText(CkString str);
String lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

int get_NumColumns();

The number of columns in the 1st row, which may be the row containing column names if HasColumnNames is true.

int get_NumRows();

The number of data rows. If the CSV has column names, the 1st row is not included in the count. Also, empty lines containing only whitespace characters that follow the last non-empty row are not included.

boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

void get_Version(CkString str);
String version();

Version of the component/library, such as "9.4.1.42"

Methods

boolean DeleteColumn(int index);

Deletes the Nth column. (The 1st column is at index 0.)

Returns true for success, false for failure.

boolean DeleteColumnByName(String columnName);

Deletes a column specified by name.

Returns true for success, false for failure.

boolean DeleteRow(int index);

Deletes the entire Nth row. (The 1st row is at index 0.)

Returns true for success, false for failure.

boolean GetCell(int row, int col, CkString outStr);
String getCell(int row, int col);

Returns the contents of the cell at row, col. Indexing begins at 0. (The topmost/leftmost cell is at 0,0)

Returns true for success, false for failure.

boolean GetCellByName(int rowIndex, String columnName, CkString outStr);
String getCellByName(int rowIndex, String columnName);

The same as GetCell, but the column is specified by name instead of by index.

Returns true for success, false for failure.

boolean GetColumnName(int index, CkString outStr);
String getColumnName(int index);

Returns the name of the Nth column.

Returns true for success, false for failure.

int GetIndex(String columnName);

Returns the column index for a given column.

int GetNumCols(int row);

Returns the number of columns for a specific row. If the row is larger than the number of rows in the CSV, a zero is returned.

boolean LoadFile(String path);

Loads a CSV from a file. It is assumed that the CSV file contains ANSI characters.

Returns true for success, false for failure.

boolean LoadFile2(String filename, String charset);

Loads a CSV from a file. The charset specifies the character encoding of the CSV file. A list of supported character encodings may be found on this page: Supported Charsets.

Returns true for success, false for failure.

boolean LoadFromString(String csvData);

Loads a CSV document from an in-memory string variable.

Returns true for success, false for failure.

boolean RowMatches(int rowIndex, String matchPattern, boolean caseSensitive);

Compares the contents of an entire row to a wildcarded match pattern where "*" can be used any number of times to match 0 or more of any character. Returns true if a match was found, otherwise returns false. If caseSensitive is true, then the pattern match is case sensitive, otherwise it is case insensitive.

boolean SaveFile(String path);

Saves a CSV to a file. The output file is written using the ANSI character encoding.

Returns true for success, false for failure.

boolean SaveFile2(String filename, String charset);

Saves a CSV to a file. The charset specifies the character encoding to use for the CSV file. The text data is converted to this charset when saving. A list of supported character encodings may be found on this page: Supported Charsets.

Returns true for success, false for failure.

boolean SaveLastError(String path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

boolean SaveToString(CkString outStr);
String saveToString();

Writes the entire CSV document to a string variable.

Returns true for success, false for failure.

boolean SetCell(int row, int col, String content);

Sets the contents for a single cell in the CSV. The content may include any characters including CRLF's, double-quotes, and the delimiter character. The Save* methods automatically double-quote fields with special chars when saving. The Load* methods automatically parse double-quoted and/or escaped fields correctly when loading.

Returns true for success, false for failure.

boolean SetCellByName(int rowIndex, String columnName, String contentStr);

The same as SetCell, except the column is specified by name instead of by index.

Returns true for success, false for failure.

boolean SetColumnName(int index, String columnName);

Sets the name of the Nth column. The first column is at index 0. This method would only return false if an invalid index is passed (such as a negative number).

Returns true for success, false for failure.

boolean SortByColumn(String columnName, boolean ascending, boolean caseSensitive);

Sorts the rows in the CSV by the contents of a specific column. If ascending is true, the sort is in ascending order, otherwise descending order. If caseSensitive is true then the sorting is case sensitive.

Returns true for success, false for failure.