org.alfresco.textgen

Interface RandomTextProvider

All Known Implementing Classes:

TextGenerator

public interface RandomTextProvider

Provides an input stream of text generated at random from real words and supported creating query text for use against this generated content.

Since:

1.0

Author:

Andy Hind

Method Summary

Modifier and Type	Method and Description
String	generateQueryString(int words, double approximateFrequency) Generate a query string that may match in some way against the corpus of generated documents as a whole.
String	generateQueryString(long seed, int words, int wordLimit) Generate a query string that exactly matches the specific random content in some way
InputStream	getInputStream(long seed, long length, String... strings) Generate a repeatable input stream made up of random words.

Method Detail

getInputStream

InputStream getInputStream(long seed,
                           long length,
                           String... strings)
                    throws IOException

Generate a repeatable input stream made up of random words. The stream may be padded with empty space to achieve the required length.

Parameters:

seed - - the initial seed for the state of the generator - to give repeatable content

length - - the length of content required in bytes

strings - - an optional array of strings. The first will be in 100% of streams generated, the next 10%, the next 1% etc. Null values will be skipped, so you could add a fixed word to 10% and 0.1% of documents using ...., null, "10", null, ".1")

Throws:

IOException

generateQueryString

String generateQueryString(long seed,
                           int words,
                           int wordLimit)

Generate a query string that exactly matches the specific random content in some way

Parameters:

seed - - the initial seed for the state of the generator - to give repeatable content

words - - the number of words required in the query string

wordLimit - - the number of words to consider from the generated stream.

generateQueryString

String generateQueryString(int words,
                           double approximateFrequency)

Generate a query string that may match in some way against the corpus of generated documents as a whole.

Parameters:

words - - the number of words required in the query string