com.softslate.commerce.daos.core
Interface DAOUtils

All Known Implementing Classes:

DAOUtilsImpl

public interface DAOUtils

Method Summary

java.lang.String	generateKeyPair(java.lang.String publicFile, java.lang.String privateFile, boolean savePrivate)
void	generateTwoWayKey(java.lang.String keyFile)
java.util.Collection	getCollectionFromBeans(java.util.Collection collection, java.lang.String field) Given a Collection of beans representing a ResultSet, and a field name for a field, returns a Collection of Integers representing each field's value in the incoming Collection.
java.util.Collection	getCollectionFromCollection(java.util.Collection collection, java.lang.String field) Given a Collection of Maps representing a ResultSet, and a field name for a field, returns a Collection of Strings representing each field's value in the incoming Collection.
java.util.Collection	getCollectionFromResultSet(java.sql.ResultSet resultSet, java.lang.String field) Given a ResultSet and a field name for a field, returns a Collection of Strings representing each field value in the ResultSet.
java.lang.String	getDebugMessage(java.sql.ResultSet resultSet) Retrieves a string indicating the number of rows and columns returned from a ResultSet.
java.lang.String	getDecrypted(java.lang.String stringToDecrypt, java.lang.String encryptionType, java.lang.String privateKeyFile) Decrypts a string using the given encryption type.
java.lang.String	getEncrypted(java.lang.String stringToEncrypt, java.lang.String encryptionType, java.lang.String publicKeyFile) Encrypts a string using the given encryption type.
java.util.Collection	getIntegersFromStrings(java.util.Collection collection) Given a Collection of Strings, returns a collection of Integers corresponding to the strings.
java.lang.String	getList(java.lang.String[] stringArray) Given an array of strings, returns a single string that can be used as a list in an SQL expression.
java.lang.String	getListFromCollection(java.util.Collection collection, java.lang.String field) Given a Collection of Maps representing a ResultSet, and a field name for a field, returns a String list representing each field's value in the incoming Collection.
java.lang.String	getListFromResultSet(java.sql.ResultSet resultSet, java.lang.String field) Given a ResultSet and a field name, returns a single string that can be used as a list in an SQL expression.
java.lang.String	getListFromStringCollection(java.util.Collection collection) Given a Collection of Strings, returns a String list representing each element's value in the incoming Collection.
java.lang.String	getQuotedList(java.util.Map map) Given a Map of string keys, returns a single string that can be used as a list in an SQL expression.
java.lang.String	getQuotedList(java.lang.String[] stringArray) Given an array of strings, returns a single string that can be used as a list in an SQL expression.
java.lang.String[]	getStopWords() An array of strings to eliminate from database search queries.
void	outputCsv(java.util.Collection data, java.io.Writer out) Outputs a matrix of strings as comma-separated values.
java.lang.String	prepareSearchString(java.lang.String searchString) Prepares a string for insertion into an SQL search expression.

Method Detail

getStopWords

java.lang.String[] getStopWords()

An array of strings to eliminate from database search queries.

getList

java.lang.String getList(java.lang.String[] stringArray)

Given an array of strings, returns a single string that can be used as a list in an SQL expression. Each of the elements of the incoming array are separated by commas.

Parameters:

stringArray - The array of strings to convert into a comma-separated list.

Returns:

A string that can be used as a list in an SQL expression.

getQuotedList

java.lang.String getQuotedList(java.lang.String[] stringArray)

Given an array of strings, returns a single string that can be used as a list in an SQL expression. Each of the elements of the incoming array are quoted and separated by commas.

Parameters:

stringArray - The array of strings to convert into a quoted string.

Returns:

A string that can be used as a list in an SQL expression.

getListFromResultSet

java.lang.String getListFromResultSet(java.sql.ResultSet resultSet,
                                      java.lang.String field)
                                      throws java.sql.SQLException

Given a ResultSet and a field name, returns a single string that can be used as a list in an SQL expression. Each of the elements of the incoming ResultSet corresponding to the given field are separated by commas. Helpful for older databases that do not support sub queries.

Parameters:

resultSet - The ResultSet holding the values.

field - The name of the field whose values are to be returned in a list.

Returns:

A string that can be used as a list in an SQL expression

Throws:

java.sql.SQLException

getListFromCollection

java.lang.String getListFromCollection(java.util.Collection collection,
                                       java.lang.String field)

Given a Collection of Maps representing a ResultSet, and a field name for a field, returns a String list representing each field's value in the incoming Collection.

Parameters:

collection - The Collection holding the values.

Returns:

A string that can be used as a list in an SQL expression.

getListFromStringCollection

java.lang.String getListFromStringCollection(java.util.Collection collection)

Given a Collection of Strings, returns a String list representing each element's value in the incoming Collection.

Parameters:

collection - The Collection holding the values.

Returns:

A string that can be used as a list in an SQL expression.

getCollectionFromResultSet

java.util.Collection getCollectionFromResultSet(java.sql.ResultSet resultSet,
                                                java.lang.String field)
                                                throws java.sql.SQLException

Given a ResultSet and a field name for a field, returns a Collection of Strings representing each field value in the ResultSet.

Parameters:

resultSet - The ResultSet holding the values.

field - The name of the field whose values are to be returned in a Colleciton.

Returns:

A Collection of Strings representing each field value in the ResultSet

Throws:

java.sql.SQLException

getCollectionFromCollection

java.util.Collection getCollectionFromCollection(java.util.Collection collection,
                                                 java.lang.String field)

Given a Collection of Maps representing a ResultSet, and a field name for a field, returns a Collection of Strings representing each field's value in the incoming Collection.

Parameters:

collection - The Collection holding the values.

field - The name of the field whose values are to be returned in a Collection.

Returns:

A Collection of Strings representing each field's value in the incoming Collection

getCollectionFromBeans

java.util.Collection getCollectionFromBeans(java.util.Collection collection,
                                            java.lang.String field)
                                            throws java.lang.Exception

Given a Collection of beans representing a ResultSet, and a field name for a field, returns a Collection of Integers representing each field's value in the incoming Collection.

Parameters:

collection - The Collection holding the values.

field - The name of the field whose values are to be returned in a Collection.

Returns:

a Collection of Integers

Throws:

java.lang.Exception

getIntegersFromStrings

java.util.Collection getIntegersFromStrings(java.util.Collection collection)

Given a Collection of Strings, returns a collection of Integers corresponding to the strings.

Parameters:

collection - A collection of Strings

Returns:

A collection of Integers

getDebugMessage

java.lang.String getDebugMessage(java.sql.ResultSet resultSet)
                                 throws java.sql.SQLException

Retrieves a string indicating the number of rows and columns returned from a ResultSet.

Parameters:

resultSet - The ResultSet to produce a debugging message for.

Returns:

A string indicating the number of rows and columns returned from a ResultSet.

Throws:

java.sql.SQLException

getQuotedList

java.lang.String getQuotedList(java.util.Map map)
                               throws java.lang.Exception

Given a Map of string keys, returns a single string that can be used as a list in an SQL expression. Each of the elements of the incoming Map are quoted and separated by commas.

Parameters:

map - The Map to convert into a quoted string.

Returns:

A string that can be used as a list in an SQL expression.

Throws:

java.lang.Exception

outputCsv

void outputCsv(java.util.Collection data,
               java.io.Writer out)
               throws java.io.IOException

Outputs a matrix of strings as comma-separated values. This implementation encloses problem values in double-quotes, prepends backslash to embedded double-quotes and backslashes, and represents embedded newlines as backslash-n.

Parameters:

data - List of String arrays or Object arrays.

out - The stream to write to.

Throws:

java.io.IOException

prepareSearchString

java.lang.String prepareSearchString(java.lang.String searchString)

Prepares a string for insertion into an SQL search expression. Adds % to the beginning and end of the string and in between each word. Also strips the string of characters dangerous to an SQL search expression.

Parameters:

searchString -

Returns:

A string acceptable for a LIKE expression.

getEncrypted

java.lang.String getEncrypted(java.lang.String stringToEncrypt,
                              java.lang.String encryptionType,
                              java.lang.String publicKeyFile)

Encrypts a string using the given encryption type.

Parameters:

stringToEncrypt - The String to encrypt.

encryptionType - "noEncryption", "keyPairStore", "keyPairNoStore", or "oneWay".

Returns:

The encrypted string

Throws:

java.lang.Exception

getDecrypted

java.lang.String getDecrypted(java.lang.String stringToDecrypt,
                              java.lang.String encryptionType,
                              java.lang.String privateKeyFile)

Decrypts a string using the given encryption type.

Parameters:

stringToDecrypt - The String to decrypt.

encryptionType - "noEncryption", "keyPairStore", "keyPairNoStore", or "oneWay".

Returns:

The decrypted string

Throws:

java.lang.Exception

generateTwoWayKey

void generateTwoWayKey(java.lang.String keyFile)
                       throws java.lang.Exception

Throws:

java.lang.Exception

generateKeyPair

java.lang.String generateKeyPair(java.lang.String publicFile,
                                 java.lang.String privateFile,
                                 boolean savePrivate)
                                 throws java.lang.Exception

Throws:

java.lang.Exception