com.mkaz.servlet API Documentation


com.mkaz.servlet
Class servletlib

java.lang.Object
  |
  +--com.mkaz.servlet.servletlib

public class servletlib
extends java.lang.Object

com.mkaz.servletlib is a java library which provides shortcut methods to ease the development of servlet web applications. .

Example Usage:


      servletlib slib = new servletlib();	
 
 


Constructor Summary
servletlib()
          Main Constructor.
 
Method Summary
 java.lang.String formatTimeStamp(java.lang.String ts)
          Converts a TimeStamp format into a nice display format.
 java.lang.String procDBDate(java.lang.String str)
          Takes a date format and returns appropiate format to insert into DB.
static java.lang.String procDBText(java.lang.String str, int level)
          Takes text to be inserted into a database and processes it for apostrophes and HTML.
 java.lang.String reverseDBText(java.lang.String str, int level)
          Takes text processed by procDBText and converts it back to the original text.
 boolean sendEmail(java.lang.String to, java.lang.String subject, java.lang.String message)
          Sends out an e-mail, based on the supplied parameters.
 java.lang.String switchDateFormat(java.lang.String sd)
          Switches the date format for display purposes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

servletlib

public servletlib()
Main Constructor. You need to create an servletlib object to use the methods against.

Example: servletlib slib = new servletlib();

Method Detail

procDBText

public static java.lang.String procDBText(java.lang.String str,
                                          int level)
                                   throws java.lang.Exception
Takes text to be inserted into a database and processes it for apostrophes and HTML. All line breaks are replaced with <BR> and all http:// links are created
Parameters:
String - str to be inserted in
int - 0,1,2 level of HTML to allow
0 = none
1 = bold, italic (only)
2 = all
Returns:
String processed text

reverseDBText

public java.lang.String reverseDBText(java.lang.String str,
                                      int level)
                               throws java.lang.Exception
Takes text processed by procDBText and converts it back to the original text. Used to display the text in a text field (textarea) verse displaying the text as HTML
Parameters:
String - str to be reversed back
int - 0,1,2 level of HTML to allow
0 = none
1 = bold, italic (only)
2 = all
Returns:
String processed text

procDBDate

public java.lang.String procDBDate(java.lang.String str)
                            throws java.lang.Exception
Takes a date format and returns appropiate format to insert into DB. Accepted passed formats are MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY returns YYYY-MM-DD.
Parameters:
String - datestr in format MM-DD-YYYY
Returns:
String YYYY-MM-DD

switchDateFormat

public java.lang.String switchDateFormat(java.lang.String sd)
Switches the date format for display purposes. Takes a date format YYYY-MM-DD or YYYY/MM/DD and returns MM-DD-YYYY and vice versa
Parameters:
String - datestr in format YYYY-MM-DD or MM-DD-YYYY
Returns:
String switched format MM-DD-YYYY returns value passed in if the passed string is not the proper format

formatTimeStamp

public java.lang.String formatTimeStamp(java.lang.String ts)
Converts a TimeStamp format into a nice display format. Takes a TimeStamp format YYYYMMDDHHMMSS (ie MySQL TimeStamp) and returns a formatted date string MM-DD-YYYY HH:MM:SS
Parameters:
String - ts in format YYYYMMDDHHMMSS
Returns:
String MM-DD-YYYY HH:MM:SS returns value passed in if the passed string is not the proper format

sendEmail

public boolean sendEmail(java.lang.String to,
                         java.lang.String subject,
                         java.lang.String message)
                  throws java.lang.Exception
Sends out an e-mail, based on the supplied parameters. Requires JavaMail API 1.1.2 to be installed correctly http://java.sun.com/products/javamail
Parameters:
String - to To e-mail address
String - subject Subject line of e-mail
String - message Message to send
Returns:
boolean true if message sent properly, throws Exception if not