| org.griphyn.vdl.dbschema.Annotation
All known Subclasses: org.griphyn.vdl.dbschema.AnnotationSchema,
| Annotation | | public interface Annotation extends Catalog(Code) | | This common schema interface defines the schemas in which the
abstraction layers access the metadata associated with VDC elements.
This layer is independent of the implementing database, and does so
by going via the database driver class API.
author:
Jens-S. Vöckler
author:
Yong Zhao
version:
$Revision: 50 $
See Also: org.griphyn.vdl.dbschema.DatabaseSchema
See Also:
See Also: org.griphyn.vdl.dbdriver
See Also: |
| Field Summary | |
| final public static int | CLASS_CALL
Annotations for call statements. | | final public static int | CLASS_DECLARE
Annotations for formal arguments. | | final public static int | CLASS_DERIVATION
Annotations for derivations. | | final public static int | CLASS_FILENAME
Annotations for logical filenames. | | final public static int | CLASS_TRANSFORMATION
Annotations for transformations. |
| Method Summary | |
| public boolean | deleteAnnotation(String primary, Object secondary, int kind, String key)
Deletes an annotation with the specified key.
Parameters:
primary - is the primary object specifier for the class. | | public boolean | deleteAnnotationCall(String fqdi, int index, String key)
Deletes a specific key for a call statement. | | public boolean | deleteAnnotationDeclare(String fqdi, String farg, String key)
Deletes a specific key in an annotated formal argument. | | public boolean | deleteAnnotationDerivation(String fqdi, String key)
Deletes a specific key in an annotated derivation. | | public boolean | deleteAnnotationFilename(String filename, String key)
Deletes a specific key in an annotated filename. | | public boolean | deleteAnnotationTransformation(String fqdi, String key)
Deletes a specific key in an annotated transformation. | | public Tuple | loadAnnotation(String primary, Object secondary, int kind, String key)
Retrieves a specific annotation from an annotatable classes with
the specified tuple. | | public java.util.List | loadAnnotation(String primary, Object secondary, int kind)
Retrieves all annotations from an annotatable classes with
the specified tuple. | | public Tuple | loadAnnotationCall(String fqdi, int index, String key)
Obtains the value to a specific key for a call statement. | | public java.util.List | loadAnnotationCall(String fqdi, int index)
Lists all annotations for a call statement.
Parameters:
fqdi - is the FQDI of the transformation
Parameters:
index - is the number of the call to annotate. | | public Tuple | loadAnnotationDeclare(String fqdi, String farg, String key)
Obtains the value to a specific key in an annotated formal argument. | | public java.util.List | loadAnnotationDeclare(String fqdi, String farg)
Lists all annotations for a formal argument. | | public Tuple | loadAnnotationDerivation(String fqdi, String key)
Obtains the value to a specific key in an annotated derivation. | | public java.util.List | loadAnnotationDerivation(String fqdi)
Lists all annotations for a derivation. | | public Tuple | loadAnnotationFilename(String filename, String key)
Obtains the value to a specific key in an annotated filename. | | public java.util.List | loadAnnotationFilename(String filename)
Lists all annotations for a logical filename.
Parameters:
filename - is the logical filename. | | public Tuple | loadAnnotationTransformation(String fqdi, String key)
Obtains the value to a specific key in an annotated transformation. | | public java.util.List | loadAnnotationTransformation(String fqdi)
Lists all annotations for a transformation. | | public long | saveAnnotation(String primary, Object secondary, int kind, Tuple annotation, boolean overwrite)
Annotates any of the annotatable classes with the specified tuple.
This is an interface method to the various class-specific methods.
Parameters:
primary - is the primary object specifier for the class. | | public long | saveAnnotationCall(String fqdi, int index, Tuple annotation, boolean overwrite)
Annotates a transformation call with a tuple.
Parameters:
fqdi - is the FQDI to annotate
Parameters:
index - is the number of the call to annotate.
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. | | public long | saveAnnotationDeclare(String fqdi, String formalname, Tuple annotation, boolean overwrite)
Annotates a transformation argument with a tuple.
Parameters:
fqdi - is the FQDI to annotate
Parameters:
formalname - is the name of the formal argument to annotoate.
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. | | public long | saveAnnotationDerivation(String fqdi, Tuple annotation, boolean overwrite)
Annotates a derivation with a tuple.
Parameters:
fqdi - is the FQDI to annotate
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. | | public long | saveAnnotationFilename(String filename, Tuple annotation, boolean overwrite)
Annotates a logical filename with a tuple.
Parameters:
filename - is the FQDI to annotate
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. | | public long | saveAnnotationTransformation(String fqdi, Tuple annotation, boolean overwrite)
Annotates a transformation with a tuple.
Parameters:
fqdi - is the FQDI to annotate
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. | | abstract public java.util.List | searchAnnotation(int kind, Object arg, QueryTree tree)
Search for LFNs or Definitions that has certain annotations
Parameters:
kind - defines the kind/class of object annotated.
Parameters:
arg - is used only for TR ARG and TR CALL. |
| CLASS_CALL | | final public static int CLASS_CALL(Code) | | Annotations for call statements.
|
| CLASS_DECLARE | | final public static int CLASS_DECLARE(Code) | | Annotations for formal arguments.
|
| CLASS_DERIVATION | | final public static int CLASS_DERIVATION(Code) | | Annotations for derivations.
|
| CLASS_FILENAME | | final public static int CLASS_FILENAME(Code) | | Annotations for logical filenames.
|
| CLASS_TRANSFORMATION | | final public static int CLASS_TRANSFORMATION(Code) | | Annotations for transformations.
|
| deleteAnnotation | | public boolean deleteAnnotation(String primary, Object secondary, int kind, String key) throws SQLException, IllegalArgumentException(Code) | | Deletes an annotation with the specified key.
Parameters:
primary - is the primary object specifier for the class. According to the type, this is either the FQDI, or the filename.
Parameters:
secondary - is a helper argument for annotations to callsand formal arguments, and should be null for all other classes.For calls, the argument must be packed into java.lang.Integer.
Parameters:
kind - defines the kind/class of object to annotate.
Parameters:
key - is the annotation key. true, if the database was modified, false otherwise.
exception:
SQLException - , if something went wrong during databaseaccess. |
| deleteAnnotationCall | | public boolean deleteAnnotationCall(String fqdi, int index, String key) throws SQLException, IllegalArgumentException(Code) | | Deletes a specific key for a call statement.
Parameters:
fqdi - is the FQDI of the transformation
Parameters:
index - is the number of the call to annotate.
Parameters:
key - is the key to search for true, if the database was modified, false otherwise.
See Also: org.griphyn.vdl.classes.Call |
| loadAnnotation | | public Tuple loadAnnotation(String primary, Object secondary, int kind, String key) throws SQLException, IllegalArgumentException(Code) | | Retrieves a specific annotation from an annotatable classes with
the specified tuple. This is an interface method to the various
class-specific methods.
Parameters:
primary - is the primary object specifier for the class. According to the type, this is either the FQDI, or the filename.
Parameters:
secondary - is a helper argument for annotations to callsand formal arguments, and should be null for all other classes.For calls, the argument must be packed into java.lang.Integer.
Parameters:
kind - defines the kind/class of object to annotate.
Parameters:
key - is the key to look for. null if not found, otherwise the annotation tuple.
See Also: Annotation.loadAnnotationTransformation(String,String)
See Also: Annotation.loadAnnotationDerivation(String,String)
See Also: Annotation.loadAnnotationCall(String,int,String)
See Also: Annotation.loadAnnotationDeclare(String,String,String)
See Also: Annotation.loadAnnotationFilename(String,String) |
| loadAnnotation | | public java.util.List loadAnnotation(String primary, Object secondary, int kind) throws SQLException, IllegalArgumentException(Code) | | Retrieves all annotations from an annotatable classes with
the specified tuple. This is an interface method to the various
class-specific methods.
Parameters:
primary - is the primary object specifier for the class. According to the type, this is either the FQDI, or the filename.
Parameters:
secondary - is a helper argument for annotations to callsand formal arguments, and should be null for all other classes.For calls, the argument must be packed into java.lang.Integer.
Parameters:
kind - defines the kind/class of object to annotate. null if not found, otherwise the annotation tuple.
See Also: Annotation.loadAnnotationTransformation(String)
See Also: Annotation.loadAnnotationDerivation(String)
See Also: Annotation.loadAnnotationCall(String,int)
See Also: Annotation.loadAnnotationDeclare(String,String)
See Also: Annotation.loadAnnotationFilename(String) |
| saveAnnotation | | public long saveAnnotation(String primary, Object secondary, int kind, Tuple annotation, boolean overwrite) throws SQLException, IllegalArgumentException(Code) | | Annotates any of the annotatable classes with the specified tuple.
This is an interface method to the various class-specific methods.
Parameters:
primary - is the primary object specifier for the class. According to the type, this is either the FQDI, or the filename.
Parameters:
secondary - is a helper argument for annotations to callsand formal arguments, and should be null for all other classes.For calls, the argument must be packed into java.lang.Integer.
Parameters:
kind - defines the kind/class of object to annotate.
Parameters:
annotation - is the value to place into the class.
Parameters:
overwrite - is a predicate on replace or maintain. the insertion id, or -1, if the database was untouched
See Also: Annotation.saveAnnotationTransformation(String,Tuple,boolean)
See Also: Annotation.saveAnnotationDerivation(String,Tuple,boolean)
See Also: Annotation.saveAnnotationCall(String,int,Tuple,boolean)
See Also: Annotation.saveAnnotationDeclare(String,String,Tuple,boolean)
See Also: Annotation.saveAnnotationFilename(String,Tuple,boolean) |
| saveAnnotationCall | | public long saveAnnotationCall(String fqdi, int index, Tuple annotation, boolean overwrite) throws SQLException, IllegalArgumentException(Code) | | Annotates a transformation call with a tuple.
Parameters:
fqdi - is the FQDI to annotate
Parameters:
index - is the number of the call to annotate.
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. the insertion id, or -1, if the database was untouched
See Also: org.griphyn.vdl.classes.Call |
| saveAnnotationDeclare | | public long saveAnnotationDeclare(String fqdi, String formalname, Tuple annotation, boolean overwrite) throws SQLException, IllegalArgumentException(Code) | | Annotates a transformation argument with a tuple.
Parameters:
fqdi - is the FQDI to annotate
Parameters:
formalname - is the name of the formal argument to annotoate.
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. the insertion id, or -1, if the database was untouched
See Also: org.griphyn.vdl.classes.Declare |
| saveAnnotationDerivation | | public long saveAnnotationDerivation(String fqdi, Tuple annotation, boolean overwrite) throws SQLException, IllegalArgumentException(Code) | | Annotates a derivation with a tuple.
Parameters:
fqdi - is the FQDI to annotate
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. the insertion id, or -1, if the database was untouched
See Also: org.griphyn.vdl.classes.Derivation |
| saveAnnotationFilename | | public long saveAnnotationFilename(String filename, Tuple annotation, boolean overwrite) throws SQLException, IllegalArgumentException(Code) | | Annotates a logical filename with a tuple.
Parameters:
filename - is the FQDI to annotate
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. the insertion id, or -1, if the database was untouched
See Also: org.griphyn.vdl.classes.LFN |
| saveAnnotationTransformation | | public long saveAnnotationTransformation(String fqdi, Tuple annotation, boolean overwrite) throws SQLException, IllegalArgumentException(Code) | | Annotates a transformation with a tuple.
Parameters:
fqdi - is the FQDI to annotate
Parameters:
annotation - is the value to place
Parameters:
overwrite - is a predicate on replace or maintain. the insertion id, or -1, if the database was untouched
See Also: org.griphyn.vdl.classes.Transformation |
| searchAnnotation | | abstract public java.util.List searchAnnotation(int kind, Object arg, QueryTree tree) throws java.sql.SQLException(Code) | | Search for LFNs or Definitions that has certain annotations
Parameters:
kind - defines the kind/class of object annotated.
Parameters:
arg - is used only for TR ARG and TR CALL. For the formerit is the name of the argument (String), for the latter the position of the call (Integer).
Parameters:
tree - stores the query tree to query the annotation a list of LFNs if search for filenames, otherwise a list ofdefinitions.
exception:
SQLException - if something goes wrong with the database.
See Also: org.griphyn.vdl.annotation.QueryTree |
|
|