An interface that allows executing a method and returning a success/failed code.

Encapsulates a caches store with a LRU and TTL removal policy, all methods of this class are synchronized. A store is uniquly identified by its name. Each store has a maximum size of items and a Time-To-Live (TTL) in seconds for its items.

To create a cache store use the StoreFactory.createStore() static method.

Warning 1: When two classes access the same store/key, one can modify a cached value that the other may use. Cached objects are available to all classes in the JVM. If you are concerned about this issue, store only immutable objects in the store.
Warning 2: Some objects have restrictions on how to read them, for example, the JDBC ResultSet after fully reading it, requires that you call the first() method in order to read it again. (Assuming you have the right JDBC driver)

The removal order of a CircularFifoBuffer is based on the insertion order; elements are removed in the same order in which they were added. The iteration order is the same as the removal order.

The add(Object), remove() and get() operations all perform in constant time. All other operations perform in linear time or worse.

Note that this implementation is not synchronized. The following can be used to provide synchronized access to your CircularFifoBuffer:

   Buffer fifo = BufferUtils.synchronizedBuffer(new CircularFifoBuffer());
 

Notice that this interface extends the IGraphNode interface.

1. Key
2. Contents
3. List of its children. Each child is an IGraphStructuredStackNode object. Children will have distinct keys.
4. List of its parents. Each parent is an IGraphStructuredStackNode object. A node CAN have more than one parents with the same key. However, the list of parents will not contain the same parent node more than once.

1. Can read/write to a text file where each line is an item in the list.
2. Can populate from a page at a given URL where each line is an item in the list.
3. Items can be in the form: name=value. With methods to access by name.
4. Many different indexOf() methods.
5. Intersection/Difference/Merge two lists.
6. Sort items of the list.

A RowList represents a growable table of data. A row within the RowList can contain many columns, however, each row in the RowList will contain the same number of columns. A column within a RowList consists of a column name and a column value.

A RowList can be populated from a Map, an array of Objects, or a List by invoking the appropriate add method.

The RowList class provides getXXX methods for retrieving column values from a row. Values can be retrieved using either the index number of the row, which returns a Map where the key is the column name and the value is the column value, or by supplying the index number and the column name. Rows are numbered from 0.

For the getXXX methods, the RowList attempts to convert the underlying data to the Java type specified in the XXX part of the getXXX method and returns a suitable Java value.

When a getXXX method is called with a column name and several columns have the same name, the value of the first matching column will be returned.

Note that the class has a default package scope, and is not accessiable outside its package.

Note that the class has a default package scope, and is not accessiable outside its package.

Note that the class has a default package scope, and is not accessiable outside its package.

  abstract public Object getContents() ;
  abstract public void setContents(final Object aContents);
  abstract public boolean isEqualContents(final Object aContents);

  abstract public Object getKey();
  abstract public void setKey(final Object aKey);
  abstract public boolean isEqualKey(final Object aKey);

1. Key: must be unique for children of the same parent
2. Contents
3. List of children, each child is a also an ITree. (a recursive structure)
4. A reference to the parent ITree node of this ITree.

Note that:

1. This library uses 1 as the starting index of query parameters to stay similar to JDBC (albeit it is goofy).
2. This library uses integers to represent sizes of blobs which will restrict the size of the blob to the max represented by Integer.MAX_VALUE.
3. It does not make sense to create classes that implement the Blob interface outside the context of a JDBC driver. The Blob api requires direct connection to the db BLOB fields.

Note that:

1. This library uses 1 as the starting index of query parameters to stay similar to JDBC (albeit it is goofy).
2. This library uses integers to represent sizes of clobs which will restrict the size of the clob to the max represented by Integer.MAX_VALUE.
3. It does not make sense to create classes that implement the Clob interfaces outside the context of a JDBC driver. The Clob api requires direct connection to the db CLOB fields.

The motivation for creating this library:

1. Simplify JDBC access, including handling exceptions and logging.
2. Avoid adding a new abstraction or a framework that requires hours of learning or may impact performance.
3. Do not try to remove SQL from the picture, just make it easier to issue SQL queries.
4. If a feature is not supported by this library, the programmer can use her/his favorite method in conjunction with this library.

All the methods are:

1. Static.
2. Take a parameter of type com.tek271.util.log.ILogger that allow logging errors when errors are possible. You can use SimpleConsoleLogger.LOGGER for logging to console.
3. Handle and log exceptions so the user does not have to do try/catch.
4. When possible, return a value indicating failure. (usually false or null)

Some interesting features are:

1. Overloaded close() to close Connection, Statement, and ResultSet.
2. Given a resultset, close it, its Statement, and Connection using closeAll().
3. Open either a standard JDBC connection, or get a connection from a JNDI lookup, used typically in J2EE environments.
4. Get a row from a ResultSet as either an array or as a List.
5. Increment the value of a numeric column in a table.
6. Get the next value of an Oracle sequencer. (This does not mean that you can use Oracle only with this library, but that this method is only valid on an Oracle database.).
7. Several readCellAsXXX() methods that read a given column at a given row from a given table, where the value can be int, long, or String.
8. Read a column from a table into a ListOfString.
9. Read one row from a table into either an array or a ListOfString.
10. Run a SELECT statement and put the result into a RowList object.
11. Run a method in a transaction using the IExecutable interface.
12. Update the value of a given column in a table.
13. Overloaded write() and writeAndGetCount() methods that run write queries (insert, update, or delete).
14. Insert or update blobs using the writeLongString() method.
15. And more ...

Example:
The following example opens a db connection, reads a value from a table, then closes the db connection.

ILogger log= SimpleConsoleLogger.LOGGER;  // log errors to console
String driver= "oracle.jdbc.driver.OracleDriver";
String url= "jdbc:oracle:thin:@server1.tek271.com";
String user= "coolDude";
String password= "password";
Connection con= DbUtil.getConnectionJdbc(log, driver, url, user, password);
if (con==null) return;      // error happened and logged

String sql= "select name from employee where id=5";
String name= DbUtil.readCellAsString(log, sql, con);
if (name==null) { 
  // error happened and logged
  DbUtil.close(log, con);
  return;
}

System.out.println("Name is " + name);
DbUtil.close(log, con);

Example:

SqlWrite q = new SqlWrite(SqlWrite.UPDATE, "employee");
q.setWhere("age<18");
q.addColumn("destination", "Hawaii", true);  // true: surround Hawaii by single quotes
q.addColumn("vacationDays", 10);
System.out.println(q.toString());

The above code will generate the following SQL statement:

    UPDATE employee SET destination='Hawaii',vacationDays=10 WHERE age<18

Now, to generate an INSERT statement on the same table and columns, all we need is to call:

q.setQueryType(SqlWrite.INSERT);
System.out.println(q.toString());

Which will generate: (notice that we did not have to repeat column definitions)

    INSERT INTO employee (destination,vacationDays) VALUES ('Hawaii',10) WHERE age<18

Although this was a simple example that may not justify using the SqlWrite class, it is meant to demonstrate the basic usage. This class really shines when you have complex inserts or updates that take many lines and are hard to follow.

1. Build consistent debug or error messages.
2. Log a debug, warning, or error message to an ILogger object.
3. Convert an exception stack trace to a string.
4. Print an exception's stack trace to console, an OutputStream, or a Writer object. This is useful to print the stack trace to a web page during development.

Requires javax.mail. Can be downloaded at: http://java.sun.com/products/javamail/downloads/index.html. However, this is included with the tecuj.jar.

Generates an HTML table. To use this class,

1. Implement the interface HtmlTable.ICellCallback
2. create a new object of HtmlTable
3. initialize its properties as you like,
4. then call the toString() method.

The purpose of this class is to simplify the creation of HTML elements in Java code.

The user can (optionally) specify in the file what is the equality character and the comment start character. For example:

 _equal=>]
 _comment=%

The default Equal chars are = or : while the default Comment chars are ; or #.

Provide info/debug/warn/error methods for a client class

Implements the ILogger interface using the commons logging logger.

To use this interface you should implement it in one of your classes and pass an object of your class.

Implements the ILogger interface using Log4j

A throwable that can have multiple stack traces.

The static member SimpleConsoleLogger.LOGGER can be used instead of creating several objects of this class.

1. Has a default package scope, i.e. not visible outside this package.
2. Defines the public properties, methods, and fields of the Tokenizer class.

The class defines the following public methods:

1. set/get Text: The text or source to be tokenized.
2. getNext: abstract, implemented in the Tokenizer class. Returns the next token.
3. getList: Tokenize the source and return a list of Token objects.
4. toString: Converts the class into a string including its properties values.
5. set/is CaseSensitive: Controls if keywords are case sensitive or not.
6. set/get Keywords: A list of the keywords. E.g. if else class while.
7. set/get MultiLineCommentEnders: A list of character sequences that indicate end of a multi-line comment. E.g. */ or *).
8. set/get MultiLineCommentStarters: A list of character sequences that indicate start of a multi-line comment. E.g. /* or (*.
9. set/get NewLineMarkers: A list of character sequences that indicate the end of a line and the start of a new line. E.g. \n or \n\r.
10. set/get Separators: A list of arithmetic or punctuation separators. E.g. = + - * == <= ; : .
11. set/get SingleLineCommentMarkers: A list of character sequences that indicate the start of a single line comment. The comment may start at any position in the line. E.g. // or REM.
12. set/get StringMarkers: A list of characters that indicate the beginning/end of a string literal. E.g. " or '.
13. set/get WhiteSpaces: A list of characters that indicate a space. E.g. blank or tab.

The class also defines the following public boolean fields:

1. isReturnComments: Controls if comments should be returned as a result of tokenization. Default is true.
2. isReturnNewLineMarkers: Controls if new-line-markers should be returned as a result of tokenization. Default is true.
3. isReturnWhiteSpace: Controls if white-spaces should be returned as a result of tokenization. Default is true.

1. Extends the Tokenizer class.
2. Tokenizes a text file, reading the syntax definition from another file.

1. Initialize the syntax definition by calling setKeyworks, setCaseSensitive, setSeparators, ...
2. Call setText() and pass it the text you want to tokenize.
3. Call getNext() repeatedly. Each call will return an object of type Token. When no more tokens, a null is returned.
4. You can call getList() instead of calling getNext() many times.

1. Construct a SelectParser object using a select statement, this will also parse the Sql string.
2. getColumns: a list of selected columns
3. getTables: a list of tables in the From clause.
4. getWhere: a list of items in the where clause.
5. getGroupBy: an optional list of items in the Group by clause.
6. getOrderBy: an optional list of items in the Order by clause.

import java.util.*;
import com.tek271.util.collections.map.MapUtility;

 ...

  public interface IPerson {
    String getName();
    void setName(String name);

    Integer getAge();
    void setAge(Integer age);

    String getSsn();
    void setSsn(String ssn);
  }

  private static final Object[][] ARRAY = {
      {"name", "abdul"},
      {"age", new Integer(40)},
      {"ssn", "123456789"},
  };
  public static final Map MAP= MapUtility.toMap(ARRAY);

  public void testSetProperties() throws Exception {
    IPerson person= (IPerson) BeanFromMapBuilder.create(IPerson.class, MAP);

    System.out.println(person.getName());   // abdul
    System.out.println(person.getAge());    // 40
    System.out.println(person.getSsn());    // 123456789

    person.setName("aaa");
    System.out.println(person.getName() );  // aaa
  }
 

Some interesting features are:

1. Define some common String constants like NEW_LINE, ALPHA_CAPS, WHITE_SPACE, ...
2. Delete a set of characters from a given string.
3. equals() method with a case sensitivity flag.
4. Convert to/from Hexadecimals and Unicode.
5. Check if a value is a member in a given set of values.
6. Several overloaded indexOf(), indexOfAny(), indexOfAnyBut() methods to find the index of a value in a target.
7. Get the lastChar() of a given string.
8. Repeat a character a given number of times.
9. And more ...

History:

1. 2005.06.22: Added copy() method.
2. 2006.01.30: Added ITagTransformer and transformTags()

Implements the IMutex interface

A mutual-exclusion-lock based on the existance of a file in the file system

Define the interface of a mutual-exclusion-lock

Create an in-memory mutual-exclusion-lock

To use this class, use the static methods create() or createXxx() which will return an XmlTree object.

The program uses SAX to parse the XML document and build the tree. Some of its features:

1. You can parse an XML document from a String, InputStream, Reader, File, or URL.
2. Each XmlTree has a tag, optional text, an optional list of attributes, and an optional list of children.
3. The children are XmlTree objects also. This structure is recursive.
4. You can add, get, or delete children by index or path (slash / separated).
5. You can get/set the tag, attributes, and text of an XmlTree object.
6. You can get the string representation of an XmlTree object.

Note that this class has a package scope and is not intended to be used by classes other than XmlTree.

This parser will ignore all comments in the XML data.

This class was refactored in 2006.08.15 to extend DefaultHandler instead of HandlerBase which was deprecated.