org.LexGrid.LexBIG.cagrid.interfaces
Interface CodedNodeGraphGrid

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

public interface CodedNodeGraphGrid
extends java.io.Serializable

A virtual graph where the edges represent associations and the nodes represent concept codes. A CodedNodeGraph describes a graph that can be combined with other graphs, queried or resolved into an actual graph rendering.


Method Summary
 CodeRelationship areCodesRelated(RelationshipTypeBasedPolicy policy, NameAndValue association)
          Determine whether there is an directed edge (or transitive closure of an edge) from the source code to the target code in this graph.
 CodedNodeGraphGrid intersect(CodedNodeGraphGrid graph)
          Return the set of concepts and associations that are present in both graphs.
 CodeExistence isCodeInGraph(ConceptReference code)
          Determine whether the supplied concept code is in the graph.
 ConceptReferenceList listCodeRelationships(RelationshipDistanceBasedPolicy policy)
          Return a list of all of the associations in the graph that have the supplied source and target concepts based on distance between them.
 java.util.List<java.lang.String> listCodeRelationships(RelationshipTypeBasedPolicy policy)
          Return a list of all of the associations in the graph that have the supplied source and target concepts or, if directOnly is false, all associations whose transitive closure has the supplied associations.
 ResolvedConceptReferenceList resolveAsList(GraphResolutionPolicy policy)
          Resolve all of the coded nodes in the list, sorting by the supplied property (if any), resolving the supplied properties, resolving coded entries to the supplied depth and resolving associations to the supplied depth.
 CodedNodeGraphGrid 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.
 CodedNodeGraphGrid restrictToCodes(CodedNodeSetGrid 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.
 CodedNodeGraphGrid restrictToCodeSystem(CodingSchemeIdentification codingScheme)
          Restrict the graph to concept codes (source and target) that originate from the supplied code system.
 CodedNodeGraphGrid 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.
 CodedNodeGraphGrid restrictToSourceCodes(CodedNodeSetGrid codes)
          Restrict the graph to associations that have one of the codes in the supplied list as source codes.
 CodedNodeGraphGrid restrictToSourceCodeSystem(CodingSchemeIdentification codingScheme)
          Restrict the graph to edges that have concepts derived from the supplied code system as a source.
 CodedNodeGraphGrid restrictToTargetCodes(CodedNodeSetGrid codes)
          Restrict the graph to associations that have one of the codes in the supplied list as target codes.
 CodedNodeGraphGrid restrictToTargetCodeSystem(CodingSchemeIdentification codingScheme)
          Restrict the graph to edges that have concepts derived from the supplied code system as a target.
 CodedNodeSetGrid toNodeList(NodeListPolicy policy)
          Transform the graph into a simple of list of concept codes, removing all association information.
 CodedNodeGraphGrid union(CodedNodeGraphGrid graph)
          Return the union of the two graphs.
 

Method Detail

areCodesRelated

CodeRelationship areCodesRelated(RelationshipTypeBasedPolicy policy,
                                 NameAndValue association)
                                 throws LBInvocationException,
                                        LBParameterException,
                                        InvalidServiceContextAccess,
                                        java.rmi.RemoteException
Determine whether there is an directed edge (or transitive closure of an edge) from the source code to the target code in this graph. The last parameter determines whether only direct associations are considered or whether the transitive closure of the edge is used.

Parameters:
policy - Policy for resolving the relationship
association - Identifies the association to be tested. The name and value will be compared against the local name and URN of supported associations for participating coding schemes.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

intersect

CodedNodeGraphGrid intersect(CodedNodeGraphGrid graph)
                             throws LBInvocationException,
                                    LBParameterException,
                                    InvalidServiceContextAccess,
                                    java.rmi.RemoteException
Return the set of concepts and associations that are present in both graphs.

Parameters:
graph - Identifies the CodedNodeGraph to be intersected with.
Returns:
A new CodedNodeGraph containing the intersection result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

isCodeInGraph

CodeExistence isCodeInGraph(ConceptReference code)
                            throws LBInvocationException,
                                   LBParameterException,
                                   InvalidServiceContextAccess,
                                   java.rmi.RemoteException
Determine whether the supplied concept code is in the graph.

Parameters:
code - Identifies the coding scheme and concept code to test.
Returns:
CodeExistence True if the concept is present; otherwise False.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

listCodeRelationships

java.util.List<java.lang.String> listCodeRelationships(RelationshipTypeBasedPolicy policy)
                                                       throws LBInvocationException,
                                                              LBParameterException,
                                                              InvalidServiceContextAccess,
                                                              java.rmi.RemoteException
Return a list of all of the associations in the graph that have the supplied source and target concepts or, if directOnly is false, all associations whose transitive closure has the supplied associations.

Parameters:
policy - Policy for resolving the relationship
Returns:
The list of concept references for matching associations.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

listCodeRelationships

ConceptReferenceList listCodeRelationships(RelationshipDistanceBasedPolicy policy)
                                           throws LBInvocationException,
                                                  LBParameterException,
                                                  InvalidServiceContextAccess,
                                                  java.rmi.RemoteException
Return a list of all of the associations in the graph that have the supplied source and target concepts based on distance between them. Distance (or the No. of edges) for a direct association between a source and target codes is 1. Values if distance should be equal or greater than 1, otherwise exception is thrown. Resulting list is not based on associations source & target have, but on distance only.

Parameters:
policy - Policy for resolving the relationship
Returns:
The list of concept references for matching associations.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

resolveAsList

ResolvedConceptReferenceList resolveAsList(GraphResolutionPolicy policy)
                                           throws LBInvocationException,
                                                  LBParameterException,
                                                  InvalidServiceContextAccess,
                                                  java.rmi.RemoteException
Resolve all of the coded nodes in the list, sorting by the supplied property (if any), resolving the supplied properties, resolving coded entries to the supplied depth and resolving associations to the supplied depth.

Parameters:
policy - Policy for resolving the relationship
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToAssociations

CodedNodeGraphGrid restrictToAssociations(NameAndValueList association,
                                          NameAndValueList associationQualifiers)
                                          throws LBInvocationException,
                                                 LBParameterException,
                                                 InvalidServiceContextAccess,
                                                 java.rmi.RemoteException
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 local name and URN 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 local name and URN of supported association qualifiers for participating coding schemes.
Returns:
A new CodedNodeGraph containing the filtered result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToDirectionalNames

CodedNodeGraphGrid restrictToDirectionalNames(NameAndValueList directionalNames,
                                              NameAndValueList associationQualifiers)
                                              throws LBInvocationException,
                                                     LBParameterException,
                                                     InvalidServiceContextAccess,
                                                     java.rmi.RemoteException
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 'descendentOf'.

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 local name and URN of supported association qualifiers for participating coding schemes.
Returns:
A new CodedNodeGraph containing the filtered result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToCodes

CodedNodeGraphGrid restrictToCodes(CodedNodeSetGrid codes)
                                   throws LBInvocationException,
                                          LBParameterException,
                                          InvalidServiceContextAccess,
                                          java.rmi.RemoteException
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 containing the filtered result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToCodeSystem

CodedNodeGraphGrid restrictToCodeSystem(CodingSchemeIdentification codingScheme)
                                        throws LBInvocationException,
                                               LBParameterException,
                                               InvalidServiceContextAccess,
                                               java.rmi.RemoteException
Restrict the graph to concept 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 URN of the coding scheme to filter on.
Returns:
A new CodedNodeGraph containing the filtered result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToSourceCodes

CodedNodeGraphGrid restrictToSourceCodes(CodedNodeSetGrid codes)
                                         throws LBInvocationException,
                                                LBParameterException,
                                                InvalidServiceContextAccess,
                                                java.rmi.RemoteException
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 containing the filtered result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToSourceCodeSystem

CodedNodeGraphGrid restrictToSourceCodeSystem(CodingSchemeIdentification codingScheme)
                                              throws LBInvocationException,
                                                     LBParameterException,
                                                     InvalidServiceContextAccess,
                                                     java.rmi.RemoteException
Restrict the graph to edges that have concepts derived from the supplied code system as a source.

Parameters:
codingScheme - The local name or URN of the coding scheme to filter on.
Returns:
A new CodedNodeGraph containing the filtered result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToTargetCodes

CodedNodeGraphGrid restrictToTargetCodes(CodedNodeSetGrid codes)
                                         throws LBInvocationException,
                                                LBParameterException,
                                                InvalidServiceContextAccess,
                                                java.rmi.RemoteException
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 containing the filtered result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

restrictToTargetCodeSystem

CodedNodeGraphGrid restrictToTargetCodeSystem(CodingSchemeIdentification codingScheme)
                                              throws LBInvocationException,
                                                     LBParameterException,
                                                     InvalidServiceContextAccess,
                                                     java.rmi.RemoteException
Restrict the graph to edges that have concepts derived from the supplied code system as a target.

Parameters:
codingScheme - The local name or URN of the coding scheme to filter on.
Returns:
A new CodedNodeGraph containing the filtered result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

toNodeList

CodedNodeSetGrid toNodeList(NodeListPolicy policy)
                            throws LBInvocationException,
                                   LBParameterException,
                                   InvalidServiceContextAccess,
                                   java.rmi.RemoteException
Transform the graph into a simple of list of concept codes, removing all association information.

Parameters:
policy - Policy for resolving the relationship
Throws:
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

union

CodedNodeGraphGrid union(CodedNodeGraphGrid graph)
                         throws LBInvocationException,
                                LBParameterException,
                                InvalidServiceContextAccess,
                                java.rmi.RemoteException
Return the union of the two graphs. Union, in this context, means that the resulting graph contains the unique set of coded entries (String independent) that are present in one or both of the graphs, and the unique combination of edges (associations) present in one or both of the graphs.

Parameters:
graph - Identifies the CodedNodeGraph to merge with.
Returns:
A new CodedNodeGraph containing the merged result.
Throws:
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException

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.