org.LexGrid.LexBIG.Impl.pagedgraph
Class AbstractMultiGraph

java.lang.Object
  extended by org.LexGrid.LexBIG.Impl.pagedgraph.AbstractCodedNodeGraph
      extended by org.LexGrid.LexBIG.Impl.pagedgraph.AbstractMultiGraph
All Implemented Interfaces:
java.io.Serializable, CodedNodeGraph
Direct Known Subclasses:
IntersectGraph, UnionGraph

public abstract class AbstractMultiGraph
extends AbstractCodedNodeGraph

The Class AbstractMultiGraph.

Author:
Kevin Peterson
See Also:
Serialized Form

Constructor Summary
AbstractMultiGraph()
           
AbstractMultiGraph(CodedNodeGraph graph1, CodedNodeGraph graph2)
          Instantiates a new union graph.
 
Method Summary
 CodedNodeGraph getGraph1()
          Gets the graph1.
 CodedNodeGraph getGraph2()
          Gets the graph2.
 CodedNodeGraph restrictToAnonymous(java.lang.Boolean restrictToAnonymous)
          Return a graph that contains only the codes that are either Anonymous, Non-Anonymous, or Not Specified in the supplied list, and all edges that still have a source and target code remaining.
 CodedNodeGraph 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.
 CodedNodeGraph 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.
 CodedNodeGraph restrictToCodeSystem(java.lang.String codingScheme)
          Restrict the graph to codes (source and target) that originate from the supplied code system.
 CodedNodeGraph 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.
 CodedNodeGraph restrictToEntityTypes(LocalNameList localNameList)
          Return a graph that contains only the codes that contain an Entity Type in the supplied list, and all edges that still have a source and target code remaining.
 CodedNodeGraph restrictToSourceCodes(CodedNodeSet codes)
          Restrict the graph to associations that have one of the codes in the supplied list as source codes.
 CodedNodeGraph restrictToSourceCodeSystem(java.lang.String codingScheme)
          Restrict the graph to edges that have codes from the specified code system as a source.
 CodedNodeGraph restrictToTargetCodes(CodedNodeSet codes)
          Restrict the graph to associations that have one of the codes in the supplied list as target codes.
 CodedNodeGraph restrictToTargetCodeSystem(java.lang.String codingScheme)
          Restrict the graph to edges that have codes from the specified code system as a target.
 void setGraph1(CodedNodeGraph graph1)
          Sets the graph1.
 void setGraph2(CodedNodeGraph graph2)
          Sets the graph2.
 
Methods inherited from class org.LexGrid.LexBIG.Impl.pagedgraph.AbstractCodedNodeGraph
doResolveAsList, getLogger, intersect, isCodeInGraph, listCodeRelationships, resolveAsList, resolveAsList, resolveAsList, union
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.LexGrid.LexBIG.LexBIGService.CodedNodeGraph
areCodesRelated, listCodeRelationships, toNodeList
 

Constructor Detail

AbstractMultiGraph

public AbstractMultiGraph()

AbstractMultiGraph

public AbstractMultiGraph(CodedNodeGraph graph1,
                          CodedNodeGraph graph2)
Instantiates a new union graph.

Parameters:
graph1 - the graph1
graph2 - the graph2
Method Detail

restrictToAssociations

public CodedNodeGraph restrictToAssociations(NameAndValueList association,
                                             NameAndValueList associationQualifiers)
                                      throws LBInvocationException,
                                             LBParameterException
Description copied from interface: CodedNodeGraph
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.
Returns:
A new CodedNodeGraph representing the filtered result.
Throws:
LBInvocationException
LBParameterException

restrictToCodeSystem

public CodedNodeGraph restrictToCodeSystem(java.lang.String codingScheme)
                                    throws LBInvocationException,
                                           LBParameterException
Description copied from interface: CodedNodeGraph
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.
Returns:
A new CodedNodeGraph representing the filtered result.
Throws:
LBInvocationException
LBParameterException

restrictToCodes

public CodedNodeGraph restrictToCodes(CodedNodeSet codes)
                               throws LBInvocationException,
                                      LBParameterException
Description copied from interface: CodedNodeGraph
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.
Returns:
A new CodedNodeGraph representing the filtered result.
Throws:
LBInvocationException
LBParameterException

restrictToDirectionalNames

public CodedNodeGraph restrictToDirectionalNames(NameAndValueList directionalNames,
                                                 NameAndValueList associationQualifiers)
                                          throws LBInvocationException,
                                                 LBParameterException
Description copied from interface: CodedNodeGraph
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.
Returns:
A new CodedNodeGraph representing the filtered result.
Throws:
LBInvocationException - ,LBParameterException
LBParameterException

restrictToSourceCodeSystem

public CodedNodeGraph restrictToSourceCodeSystem(java.lang.String codingScheme)
                                          throws LBInvocationException,
                                                 LBParameterException
Description copied from interface: CodedNodeGraph
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.
Returns:
A new CodedNodeGraph representing the filtered result.
Throws:
LBInvocationException
LBParameterException

restrictToSourceCodes

public CodedNodeGraph restrictToSourceCodes(CodedNodeSet codes)
                                     throws LBInvocationException,
                                            LBParameterException
Description copied from interface: CodedNodeGraph
Restrict the graph to associations that have one of the codes in the supplied list as source codes.

Parameters:
codes - Codes to filter on.
Returns:
A new CodedNodeGraph representing the filtered result.
Throws:
LBInvocationException
LBParameterException

restrictToTargetCodeSystem

public CodedNodeGraph restrictToTargetCodeSystem(java.lang.String codingScheme)
                                          throws LBInvocationException,
                                                 LBParameterException
Description copied from interface: CodedNodeGraph
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.
Returns:
A new CodedNodeGraph representing the filtered result.
Throws:
LBInvocationException
LBParameterException

restrictToTargetCodes

public CodedNodeGraph restrictToTargetCodes(CodedNodeSet codes)
                                     throws LBInvocationException,
                                            LBParameterException
Description copied from interface: CodedNodeGraph
Restrict the graph to associations that have one of the codes in the supplied list as target codes.

Parameters:
codes - Codes to filter on.
Returns:
A new CodedNodeGraph representing the filtered result.
Throws:
LBInvocationException
LBParameterException

restrictToAnonymous

public CodedNodeGraph restrictToAnonymous(java.lang.Boolean restrictToAnonymous)
                                   throws LBInvocationException,
                                          LBParameterException
Description copied from interface: CodedNodeGraph
Return a graph that contains only the codes that are either Anonymous, Non-Anonymous, or Not Specified in the supplied list, and all edges that still have a source and target code remaining. A True value signifies Anonymous codes only A False value signifies Non-Anonymous only A Null value signifies all codes will matched

Returns:
the coded node graph
Throws:
LBInvocationException - the LB invocation exception
LBParameterException - the LB parameter exception

restrictToEntityTypes

public CodedNodeGraph restrictToEntityTypes(LocalNameList localNameList)
                                     throws LBInvocationException,
                                            LBParameterException
Description copied from interface: CodedNodeGraph
Return a graph that contains only the codes that contain an Entity Type in the supplied list, and all edges that still have a source and target code remaining.

Parameters:
localNameList - the local name list
Returns:
the coded node graph
Throws:
LBInvocationException - the LB invocation exception
LBParameterException - the LB parameter exception

getGraph1

public CodedNodeGraph getGraph1()
Gets the graph1.

Returns:
the graph1

setGraph1

public void setGraph1(CodedNodeGraph graph1)
Sets the graph1.

Parameters:
graph1 - the new graph1

getGraph2

public CodedNodeGraph getGraph2()
Gets the graph2.

Returns:
the graph2

setGraph2

public void setGraph2(CodedNodeGraph graph2)
Sets the graph2.

Parameters:
graph2 - the new graph2

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.