com.g11ntoolkit.tokenizer
Class TokSQLFile

java.lang.Object
  |
  +--com.g11ntoolkit.tokenizer.FileTokenizer
        |
        +--com.g11ntoolkit.tokenizer.TokSQLFile

public class TokSQLFile

extends FileTokenizer

Tokenizes the specified buffer as an SQL file.

This is tailored specifically for Portal SQL files. It extracts only strings enclosed in single quotes. It extracts all candidate strings regardless of their position in the file.

Version:

2005/07/22

Author:

Bill Rich, Wilandra Consulting LLC
Copyright © 2004-2005, Wilandra Consulting LLC. All rights reserved.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See License Agreement.

Field Summary

private static java.lang.String	localeString The locale for the input file.
private static java.util.logging.Logger	log The log used for all messages from this class.
protected static java.lang.String	theContextFileName The context input file name saved for later use.
protected static java.util.ResourceBundle	xliffrb Constants, messages, and variables used by the tools and classes for XLIFF processing.

Fields inherited from class com.g11ntoolkit.tokenizer.FileTokenizer

context, encoding, inFileBuffer, jspVars, mrb, product, productVersion, revContext, targetLocale, tokContext, token, vrb

Constructor Summary

TokSQLFile()
Establishes an instance of the class with no input information.

TokSQLFile(java.lang.String anEncoding)
Establishes an instance of the class and saves all the input information for use in processing the file.

TokSQLFile(java.lang.String anEncoding, java.util.Locale aLocale)
Establishes an instance of the class and saves all the input information for use in processing the file.

TokSQLFile(java.lang.String anEncoding, java.util.Locale aLocale, Token aToken)
Establishes an instance of the class and saves all the input information for use in processing the file.

Method Summary

static void	main(java.lang.String[] args) Allows this tool to be run from the command line.
private XLEntry	newXLEntry(java.lang.String fn, java.lang.String sc, java.lang.String tuse) Returns a new XLEntry for the extracted string.
static StrFile	tokenize(java.lang.String inFileName, java.lang.String contextFileName, java.util.Locale targetLocale, java.lang.String localeString) Tokenizes the buffer and writes the SQL file tok file and str file out.

Methods inherited from class com.g11ntoolkit.tokenizer.FileTokenizer

cleanConcats, getEncoding, getFileBuffer, getKey, getProductName, getProductVersion, getToken, keys, readFile, readFilePlain, setContext, setEncoding, setProductName, setProductVersion, setupTok, setupTok, tokens

Methods inherited from class java.lang.Object

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

Field Detail

log

private static java.util.logging.Logger log

The log used for all messages from this class.

xliffrb

protected static java.util.ResourceBundle xliffrb

Constants, messages, and variables used by the tools and classes for XLIFF processing.

theContextFileName

protected static java.lang.String theContextFileName

The context input file name saved for later use.

localeString

private static java.lang.String localeString

The locale for the input file.

Constructor Detail

TokSQLFile

public TokSQLFile()

Establishes an instance of the class with no input information.

It is useful for setting up the class for the check function.

TokSQLFile

public TokSQLFile(java.lang.String anEncoding,
                  java.util.Locale aLocale,
                  Token aToken)
           throws FileTokenizerError

Establishes an instance of the class and saves all the input information for use in processing the file.

Parameters:

anEncoding - a String specifying the encoding of the input file

aLocale - a Locale object specifying the locale of the strings

aToken - a Token object for use in the tokenized file created

Throws:

FileTokenizerError - when anything goes wrong

TokSQLFile

public TokSQLFile(java.lang.String anEncoding,
                  java.util.Locale aLocale)
           throws FileTokenizerError

Establishes an instance of the class and saves all the input information for use in processing the file.

Parameters:

anEncoding - a String specifying the encoding of the input file

aLocale - a Locale specifying the target locale

Throws:

FileTokenizerError - when anything goes wrong

TokSQLFile

public TokSQLFile(java.lang.String anEncoding)
           throws FileTokenizerError

Establishes an instance of the class and saves all the input information for use in processing the file.

Parameters:

anEncoding - a String specifying the encoding of the input file

Throws:

FileTokenizerError - when anything goes wrong

Method Detail

main

public static void main(java.lang.String[] args)
                 throws FileTokRunError

Allows this tool to be run from the command line.

Sets up the environment then uses the tokenize method to extract the strings.

Parameters:

args - a String array specifying the command line parameters. The order does not matter except that the arguments that are paired must be paired in order. The arguments are not case sensitive.

FileTokRunError

newXLEntry

private XLEntry newXLEntry(java.lang.String fn,
                           java.lang.String sc,
                           java.lang.String tuse)

Returns a new XLEntry for the extracted string.

Parameters:

fn - a String specifying the name of the file that contains the string

sc - a String specifying the string

tuse - a String specifying the tuse part of the context

Returns:

a XLEntry representing the XLEntry for the string

tokenize

public static StrFile tokenize(java.lang.String inFileName,
                               java.lang.String contextFileName,
                               java.util.Locale targetLocale,
                               java.lang.String localeString)
                        throws FileTokenizerError

Tokenizes the buffer and writes the SQL file tok file and str file out.

It uses the super class setupTok method to do the common work of reading the file into a string buffer.

Parameters:

inFileName - a String specifying the input file name

contextFileName - a String specifying the input file name to use as the token id and context

targetLocale - a Locale specifying the intended target locale

Returns:

a StrFile representing the extracted strings for the input file

Throws:

FileTokenizerError - if any errors occur during processing.