owltools.gaf.rules
Interface AnnotationRule

All Known Implementing Classes:
AbstractAnnotationRule, AnnotationRegularExpressionFromXMLRule, AnnotationTaxonRule, BasicChecksRule, GenericReasonerValidationCheck, GoAnnotationTaxonRule, GoClassReferenceAnnotationRule

public interface AnnotationRule


Method Summary
 String getRuleId()
          Get the ruleId.
 Set<AnnotationRuleViolation> getRuleViolations(GafDocument gafDoc)
          Given a whole GafDocument , find the set of violations using the rule
 Set<AnnotationRuleViolation> getRuleViolations(GeneAnnotation a)
          Given an annotation, find the set of violations using the rule
 boolean isDocumentLevel()
           
 void setRuleId(String ruleId)
          Set the rule id
 

Method Detail

getRuleViolations

Set<AnnotationRuleViolation> getRuleViolations(GeneAnnotation a)
Given an annotation, find the set of violations using the rule

Parameters:
a - annotation
Returns:
set of violations

getRuleViolations

Set<AnnotationRuleViolation> getRuleViolations(GafDocument gafDoc)
Given a whole GafDocument , find the set of violations using the rule

Parameters:
gafDoc -
Returns:
set of violations

setRuleId

void setRuleId(String ruleId)
Set the rule id

Parameters:
ruleId -

getRuleId

String getRuleId()
Get the ruleId.

Returns:
ruleId

isDocumentLevel

boolean isDocumentLevel()
Returns:
true if the rule has to be applied to the whole GA document.


Copyright © 2010-2012. All Rights Reserved.