All Packages  This Package  Class Hierarchy  Class Search  Index

Class xBaseJ.DateField
java.lang.Object
   |
   +----xBaseJ.Field
           |
           +----xBaseJ.DateField

  Summary

public class  DateField
     extends xBaseJ.Field
{
          // Constructors 1
     public DateField(String) throws IOException, xBaseJException;

          // Methods 11
     public int compareTo(Calendar) throws xBaseJException;
     public int compareTo(DateField);
     public String get(int) throws xBaseJException;
     public Calendar getCalendar() throws xBaseJException;
     public char getType();
     public void put(String) throws xBaseJException;
     public void put(Calendar) throws xBaseJException;
     public void put(Date) throws xBaseJException;
     public void put(long) throws xBaseJException;
     public void set(int, int) throws xBaseJException;
     public char type();
}




  Constructors

· DateField

Summary  |  Top

   public DateField(String iName)  throws IOException, xBaseJException

public method for creating a DateField object. It is not associated with a database but can be when used with some DBF methods.

Parameter Description
Name the name of the field

Throws: xBaseJException
exception caused in calling methods
Throws: IOException
can not occur but defined for calling methods

See Also: Field



  Methods

· type

Summary  |  Top
   public char type() 
Note: type() is deprecateduse getType

return the character 'D' indicating a date field

Overrides:
type in class Field


· getType

Summary  |  Top
   public char getType() 

return the character 'D' indicating a date field

Overrides:
getType in class Field


· put

Summary  |  Top
   public void put(String inValue)  throws xBaseJException

sets field contents by a String parameter.

Parameter Description
inValue String value to store - format CCYYMMDD

Throws: xBaseJException
most likely a format error
Overrides:
put in class Field


· put

Summary  |  Top
   public void put(Date inValue)  throws xBaseJException

sets field contents by a Java Date object.

Parameter Description
inValue java.util.Date value to store

Throws: xBaseJException
most likely a format error


· put

Summary  |  Top
   public void put(Calendar inValue)  throws xBaseJException

sets field contents by a Java Calendar object.

Parameter Description
inValue java.util.Calendare value to store

Throws: xBaseJException
most likely a format error


· put

Summary  |  Top
   public void put(long inValue)  throws xBaseJException

sets field contents by a long value

Parameter Description
inValue long value to store - format CCYYMMDD

Throws: xBaseJException
most likely a format error


· compareTo

Summary  |  Top
   public int compareTo(DateField compareThis) 

public method for comparing a DateField object.

Parameter Description
compareThis the other DateField object to compare



· compareTo

Summary  |  Top
   public int compareTo(Calendar compareThis)  throws xBaseJException

public method for comparing a Java Calendar object.

Parameter Description
compareThis the Date object to compare

Throws: xBaseJException
exception caused in calling methods


· getCalendar

Summary  |  Top
   public Calendar getCalendar()  throws xBaseJException

public method for returing the date field in a Java Calendar object.

Throws: xBaseJException
exception caused in calling methods


· get

Summary  |  Top
   public String get(int field)  throws xBaseJException

public method for getting individual field values

Parameter Description
field id, use Calendar.YEAR, Calendar.MONTh, Calendar.DAY_OF_MONTH

Throws: xBaseJException
exception caused in calling methods


· set

Summary  |  Top
   public void set(int field, 
                   int value)  throws xBaseJException

public method for setting individual field values

Parameter Description
field use Calendar.YEAR, Calendar.MONTh, Calendar.DAY_OF_MONTH
value - int value to set field

Throws: xBaseJException
exception caused in calling methods


All Packages  This Package  Class Hierarchy  Class Search  Index
Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7