org.LexGrid.LexBIG.Impl.pagedgraph.query
Interface GraphQueryBuilder

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DefaultGraphQueryBuilder

public interface GraphQueryBuilder
extends java.io.Serializable

The Interface GraphQueryBuilder.

Author:
Kevin Peterson

Method Summary
 GraphQuery getQuery()
          Gets the query.
 void restrictToAnonymous(java.lang.Boolean restrictToAnonymous)
           
 void restrictToAssociations(NameAndValueList association, NameAndValueList associationQualifiers)
          Restrict the graph to the nodes that participate as a source or target of the named association and, if supplied, the named association qualifiers.
 void restrictToCodes(CodedNodeSet codes)
          Return a graph that contains only the codes that are present in the supplied list, and all edges that still have a source and target code remaining.
 void restrictToCodeSystem(java.lang.String codingScheme)
          Restrict the graph to codes (source and target) that originate from the supplied code system.
 void restrictToDirectionalNames(NameAndValueList directionalNames, NameAndValueList associationQualifiers)
          Restrict the graph to the nodes that participate as a source or target of an association whose directional name matches the one provided and, if supplied, the named association qualifiers.
 void restrictToEntityTypes(LocalNameList localNameList)
           
 void restrictToSourceCodes(CodedNodeSet codes)
          Restrict the graph to associations that have one of the codes in the supplied list as source codes.
 void restrictToSourceCodeSystem(java.lang.String codingScheme)
          Restrict the graph to edges that have codes from the specified code system as a source.
 void restrictToTargetCodes(CodedNodeSet codes)
          Restrict the graph to associations that have one of the codes in the supplied list as target codes.
 void restrictToTargetCodeSystem(java.lang.String codingScheme)
          Restrict the graph to edges that have codes from the specified code system as a target.
 

Method Detail

getQuery

GraphQuery getQuery()
Gets the query.

Returns:
the query

restrictToAssociations

void restrictToAssociations(NameAndValueList association,
                            NameAndValueList associationQualifiers)
                            throws LBInvocationException,
                                   LBParameterException
Restrict the graph to the nodes that participate as a source or target of the named association and, if supplied, the named association qualifiers.

Parameters:
association - List of associations used to restrict the graph. The name and value for each item in the list will be compared against the id and URI of supported associations for participating coding schemes.
associationQualifiers - If supplied, restriction only applies to associations that are qualified by one or more of the supplied qualifiers. The name and value for each item in the list will be compared against the id and URI of supported association qualifiers for participating coding schemes.
Throws:
LBInvocationException,LBParameterException - * @throws LBInvocationException the LB invocation exception
LBParameterException - the LB parameter exception
LBInvocationException - the LB invocation exception

restrictToDirectionalNames

void restrictToDirectionalNames(NameAndValueList directionalNames,
                                NameAndValueList associationQualifiers)
                                throws LBInvocationException,
                                       LBParameterException
Restrict the graph to the nodes that participate as a source or target of an association whose directional name matches the one provided and, if supplied, the named association qualifiers. A directional name is considered to be either the forward or reverse label registered to an association defined by the ontology. Forward and reverse names are optionally assigned to each association. For example, an association 'lineage' may have a forward name 'ancestorOf' and reverse name 'descendantOf'.

Parameters:
directionalNames - List of directionalNames used to restrict the graph. A directional name is compared against the forward and reverse names for defined associations. If a given name matches more than one forward or reverse label, all corresponding associations are included in the restriction.
associationQualifiers - If supplied, restriction only applies to associations that are qualified by one or more of the supplied qualifiers. The name and value for each item in the list will be compared against the id and URI of supported association qualifiers for participating coding schemes.
Throws:
LBInvocationException - ,LBParameterException
LBParameterException - the LB parameter exception

restrictToCodes

void restrictToCodes(CodedNodeSet codes)
                     throws LBInvocationException,
                            LBParameterException
Return a graph that contains only the codes that are present in the supplied list, and all edges that still have a source and target code remaining.

Parameters:
codes - Codes to filter on.
Throws:
LBInvocationException,LBParameterException - * @throws LBInvocationException the LB invocation exception
LBParameterException - the LB parameter exception
LBInvocationException - the LB invocation exception

restrictToCodeSystem

void restrictToCodeSystem(java.lang.String codingScheme)
                          throws LBInvocationException,
                                 LBParameterException
Restrict the graph to codes (source and target) that originate from the supplied code system. Note: edges defined by other code systems will still be resolved if associated with both source and target nodes for the restricted code system.

Parameters:
codingScheme - The local name or URI of the coding scheme to filter on.
Throws:
LBInvocationException,LBParameterException - * @throws LBInvocationException the LB invocation exception
LBParameterException - the LB parameter exception
LBInvocationException - the LB invocation exception

restrictToSourceCodes

void restrictToSourceCodes(CodedNodeSet codes)
                           throws LBInvocationException,
                                  LBParameterException
Restrict the graph to associations that have one of the codes in the supplied list as source codes.

Parameters:
codes - Codes to filter on.
Throws:
LBInvocationException,LBParameterException - * @throws LBInvocationException the LB invocation exception
LBParameterException - the LB parameter exception
LBInvocationException - the LB invocation exception

restrictToSourceCodeSystem

void restrictToSourceCodeSystem(java.lang.String codingScheme)
                                throws LBInvocationException,
                                       LBParameterException
Restrict the graph to edges that have codes from the specified code system as a source.

Parameters:
codingScheme - The local name or URI of the coding scheme to filter on.
Throws:
LBInvocationException,LBParameterException - * @throws LBInvocationException the LB invocation exception
LBParameterException - the LB parameter exception
LBInvocationException - the LB invocation exception

restrictToTargetCodes

void restrictToTargetCodes(CodedNodeSet codes)
                           throws LBInvocationException,
                                  LBParameterException
Restrict the graph to associations that have one of the codes in the supplied list as target codes.

Parameters:
codes - Codes to filter on.
Throws:
LBInvocationException,LBParameterException - * @throws LBInvocationException the LB invocation exception
LBParameterException - the LB parameter exception
LBInvocationException - the LB invocation exception

restrictToTargetCodeSystem

void restrictToTargetCodeSystem(java.lang.String codingScheme)
                                throws LBInvocationException,
                                       LBParameterException
Restrict the graph to edges that have codes from the specified code system as a target.

Parameters:
codingScheme - The local name or URI of the coding scheme to filter on.
Throws:
LBInvocationException,LBParameterException - * @throws LBInvocationException the LB invocation exception
LBParameterException - the LB parameter exception
LBInvocationException - the LB invocation exception

restrictToEntityTypes

void restrictToEntityTypes(LocalNameList localNameList)
                           throws LBInvocationException,
                                  LBParameterException
Throws:
LBInvocationException
LBParameterException

restrictToAnonymous

void restrictToAnonymous(java.lang.Boolean restrictToAnonymous)
                         throws LBInvocationException,
                                LBParameterException
Throws:
LBInvocationException
LBParameterException

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.