Enterprise Information Portal APIs

com.ibm.gcs.db.component
Interface DB2Annotation

All Known Implementing Classes:
DB2DescriptionAnnotation, DB2DictionaryAnnotation

public interface DB2Annotation

The DB2Annotation interface specifies persistence methods for Annotation objects which enable the object to be read from and written to the database. Annotations to be stored in the database must implement this interface.


Field Summary
static java.lang.String copyright
          set the annotator
static int EXISTS
           
static int NOT_EXISTS
           
static int NOT_LOADED
           
 
Method Summary
 int getPersistenceState()
          The persistence state may be NOT_LOADED, EXISTS, or NOT_EXISTS.
 java.lang.String getSQLKeys()
          Returns a comma separated list of the sql keys.
 java.lang.String getSQLValueForKey(java.lang.String key)
          Returns a SQL string for the SQL key value or "default" if no value defined.
 java.lang.String getSQLValues()
          Returns a comma separated list of the sql values matching the SQL keys.
 void setPersistenceState(int state)
          The persistence state may be NOT_LOADED, EXISTS, or NOT_EXISTS.
 

Field Detail

NOT_LOADED

public static final int NOT_LOADED

EXISTS

public static final int EXISTS

NOT_EXISTS

public static final int NOT_EXISTS

copyright

public static final java.lang.String copyright
set the annotator
Method Detail

getSQLKeys

public java.lang.String getSQLKeys()
Returns a comma separated list of the sql keys. Example: href,surroundingtext, anchor
Returns:
String a comma separated list of the sql keys. Null if not keys to update or insert.

getSQLValues

public java.lang.String getSQLValues()
Returns a comma separated list of the sql values matching the SQL keys. Example: 'http://www.foobar.com/', 'The surrounding text', 'foobar'
Returns:
String a comma separated list of the sql values. Null if no values to update or insert.

getSQLValueForKey

public java.lang.String getSQLValueForKey(java.lang.String key)
Returns a SQL string for the SQL key value or "default" if no value defined.

getPersistenceState

public int getPersistenceState()
The persistence state may be NOT_LOADED, EXISTS, or NOT_EXISTS.
Returns:
int The state of this annotation object

setPersistenceState

public void setPersistenceState(int state)
The persistence state may be NOT_LOADED, EXISTS, or NOT_EXISTS.
Parameters:
int - The state of this annotation object

EIP Web Crawler APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.