com.github.jferard.fastods.ref

Class TableNameUtil

java.lang.Object

com.github.jferard.fastods.ref.TableNameUtil

public class TableNameUtil
extends Object

A TableNameUtil checks the table name and escapes it.

Author:

Julien Férard, Martin Schulz

Constructor Summary

Constructors

Constructor and Description
TableNameUtil()

Method Summary

Modifier and Type	Method and Description
void	checkTableName(CharSequence name) Check if the table name is ok.
String	escapeTableName(CharSequence tableName) 9.2.1 Referencing Table Cells "If the name of the table contains blanks, dots “.”
String	sanitizeTableName(CharSequence name) Change the table to comply with LO limitations (excepted for the check of duplicate names), but may the conditions may be relaxed in a future version.
String	unescapeFilename(String filename)
String	unescapeQuotes(String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

TableNameUtil

public TableNameUtil()

Method Detail

checkTableName

public void checkTableName(CharSequence name)

Check if the table name is ok. Currently, this does stick to LO limitations (excepted for the check of duplicate names), but may the conditions may be relaxed in a future version. A valid table name should not start with a single quote (`'`) or contain of of the following characters: left square bracket (`[`), right square bracket (`]`), star (`*`), question mark (`?`), colon (`:`), slash (`/`) or backslash (`\`).

Parameters:

name - the name to check

Throws:

IllegalArgumentException - if the table name is not accepted.

sanitizeTableName

public String sanitizeTableName(CharSequence name)

Change the table to comply with LO limitations (excepted for the check of duplicate names), but may the conditions may be relaxed in a future version. A valid table name should not start with a single quote (`'`) or contain of of the following characters: left square bracket (`[`), right square bracket (`]`), star (`*`), question mark (`?`), colon (`:`), slash (`/`) or backslash (`\`).

Parameters:

name - the name to check

Returns:

the sanitized table name. It is guaranteed that `checkTableName(return value)` will not throw an IllegalArgumentException.

escapeTableName

public String escapeTableName(CharSequence tableName)

9.2.1 Referencing Table Cells "If the name of the table contains blanks, dots “.” (U+002E, FULL STOP) or apostrophes “'” (U+0027, APOSTROPHE), the name shall be quoted with apostrophes “'” (U+0027, APOSTROPHE). Any apostrophes in the name shall be escaped by doubling the”'”( U+0027, APOSTROPHE) character."

Parameters:

tableName - the name of the table

Returns:

the name of the table escaped

unescapeFilename

public String unescapeFilename(String filename)
                        throws ParseException,
                               UnsupportedEncodingException

Parameters:

filename - the name

Returns:

the name with quotes unescaped

Throws:

ParseException - if there are no quotes

UnsupportedEncodingException - if the encoding is not UTF-8

unescapeQuotes

public String unescapeQuotes(String str)
                      throws ParseException

Parameters:

str - the name

Returns:

the name with quotes unescaped

Throws:

ParseException - if there are no quotes