|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CodedNodeGraph
A virtual graph where the edges represent associations and the nodes represent coded entries. A CodedNodeGraph describes a graph that can be combined with other graphs, queried or resolved into an actual graph rendering.
Method Summary | |
---|---|
java.lang.Boolean |
areCodesRelated(NameAndValue association,
ConceptReference sourceCode,
ConceptReference targetCode,
boolean directOnly)
Determine whether there is an directed edge (or transitive closure of an edge) from the source code to the target code in this graph. |
CodedNodeGraph |
intersect(CodedNodeGraph graph)
Return the set of nodes and associations that are present in both graphs. |
java.lang.Boolean |
isCodeInGraph(ConceptReference code)
Determine whether the supplied code is in the graph. |
java.util.List<java.lang.String> |
listCodeRelationships(ConceptReference sourceCode,
ConceptReference targetCode,
boolean directOnly)
Return a list of all of the associations in the graph that have the supplied source and target codes or, if directOnly is false, all associations whose transitive closure has the supplied associations. |
java.util.List<java.lang.String> |
listCodeRelationships(ConceptReference sourceCode,
ConceptReference targetCode,
int distance)
Return a list of all of the associations in the graph that have the supplied source and target codes based on distance between them. |
ResolvedConceptReferenceList |
resolveAsList(ConceptReference graphFocus,
boolean resolveForward,
boolean resolveBackward,
int resolveCodedEntryDepth,
int resolveAssociationDepth,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
SortOptionList sortOptions,
int maxToReturn)
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. |
ResolvedConceptReferenceList |
resolveAsList(ConceptReference graphFocus,
boolean resolveForward,
boolean resolveBackward,
int resolveCodedEntryDepth,
int resolveAssociationDepth,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
SortOptionList sortOptions,
LocalNameList filterOptions,
int maxToReturn)
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, resolving associations to the supplied depth, and allowing for additional filters to be applied against the returned items. |
ResolvedConceptReferenceList |
resolveAsList(ConceptReference graphFocus,
boolean resolveForward,
boolean resolveBackward,
int resolveCodedEntryDepth,
int resolveAssociationDepth,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
SortOptionList sortOptions,
LocalNameList filterOptions,
int maxToReturn,
boolean keepLastAssociationLevelUnresolved)
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, resolving associations to the supplied depth, and allowing for additional filters to be applied against the returned items. |
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. |
CodedNodeSet |
toNodeList(ConceptReference graphFocus,
boolean resolveForward,
boolean resolveBackward,
int resolveAssociationDepth,
int maxToReturn)
Transform the graph into a simple of list of code references, removing all association information. |
CodedNodeGraph |
union(CodedNodeGraph graph)
Return the union of the two graphs. |
Method Detail |
---|
java.lang.Boolean areCodesRelated(NameAndValue association, ConceptReference sourceCode, ConceptReference targetCode, boolean directOnly) throws LBInvocationException, LBParameterException
association
- Identifies the association to be tested. The name and value
will be compared against the id and URI of supported
associations for participating coding schemes.sourceCode
- Source code system/code to be tested.targetCode
- Target code system/code to be tested.directOnly
- True means only asserted association instances are tested.
False means that, if the association is defined as transitive,
the transitive closure of the association instances are
tested.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph intersect(CodedNodeGraph graph) throws LBInvocationException, LBParameterException
graph
- Identifies the CodedNodeGraph to be intersected with.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
java.lang.Boolean isCodeInGraph(ConceptReference code) throws LBInvocationException, LBParameterException
code
- Identifies the coding scheme and code to test.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
java.util.List<java.lang.String> listCodeRelationships(ConceptReference sourceCode, ConceptReference targetCode, boolean directOnly) throws LBInvocationException, LBParameterException
sourceCode
- Source end of the association. If null, all sources for the
specified target are included.targetCode
- Target end of the association. If null, all targets for the
specified source are included.directOnly
- True means only direct associations are tested. False means
that the transitive closure of transitive (and undefined)
associations are tested for membership.
Note that while the class of the returned value appears to imply concepts only, each contained reference inherits from the more general CodedNodeReference and is capable of representing any type of node contained by the graph.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
java.util.List<java.lang.String> listCodeRelationships(ConceptReference sourceCode, ConceptReference targetCode, int distance) throws LBInvocationException, LBParameterException
sourceCode
- Source end of the association. If null, all sources for the
specified target are included.targetCode
- Target end of the association. If null, all targets for the
specified source are included.distance
- Distance (# of edges) source and target codes must have in
between. Must be positive & greater than zero.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferenceList resolveAsList(ConceptReference graphFocus, boolean resolveForward, boolean resolveBackward, int resolveCodedEntryDepth, int resolveAssociationDepth, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, SortOptionList sortOptions, int maxToReturn) throws LBInvocationException, LBParameterException
graphFocus
- Set the top or "focus" node of the graph. If present, only
the nodes that are reachable via this node will be returned.
If null, nodes with no incoming or outgoing associations
are used as starting points for navigation of forward and
reverse relationships, respectively.resolveForward
- True means resolve in the direction of source to target.resolveBackward
- True means resolve in the direction of target to source.resolveCodedEntryDepth
- Depth in the graph to resolve coded entries. - 1 means don't
resolve anything - just return code references, 0 means
resolve just the root nodes, 1 means resolve 1 deep, etc.resolveAssociationDepth
- Number of hops to resolve associations. 0 means leave all
associations unresolved, 1 means immediate neighbors, etc. -1
means follow the entire closure of the graph.propertyNames
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.propertyTypes
- Indicates whether to resolve only specific property categories,
regardless of the assigned name. Any of the enumerated PropertyType
values can be specified. If not empty and not null, only
properties matching the given types are included for resolved
nodes.sortOptions
- List of sort options to apply during resolution. If supplied,
the sort algorithms will be applied in the order provided. Any
algorithms not valid to be applied in context of node set
iteration, as specified in the sort extension description,
will result in a parameter exception. Available algorithms can
be retrieved through the LexBIGService getSortExtensions()
method after being defined to the LexBIGServiceManager
extension registry.maxToReturn
- Maximum number of entries to return; a value less than 1
indicates to return unlimited entries (to the limit specified
in the runtime configuration file).
Each entry will include basic information for the node along with an embedded object (e.g. concept) populated with requested properties.
Note that while the class of the returned value appears to imply concepts only, each contained reference inherits from the more general CodedNodeReference and is capable of representing any type of node contained by the graph.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferenceList resolveAsList(ConceptReference graphFocus, boolean resolveForward, boolean resolveBackward, int resolveCodedEntryDepth, int resolveAssociationDepth, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, SortOptionList sortOptions, LocalNameList filterOptions, int maxToReturn) throws LBInvocationException, LBParameterException
graphFocus
- Set the top or "focus" node of the graph. If present, only
the nodes that are reachable via this node will be returned.
If null, nodes with no incoming or outgoing associations
are used as starting points for navigation of forward and
reverse relationships, respectively.resolveForward
- True means resolve in the direction of source to target.resolveBackward
- True means resolve in the direction of target to source.resolveCodedEntryDepth
- Depth in the graph to resolve coded entries. - 1 means don't
resolve anything - just return the code references, 0 means
resolve just the root nodes, 1 means resolve 1 deep, etc.resolveAssociationDepth
- Number of hops to resolve associations. 0 means leave all
associations unresolved, 1 means immediate neighbors, etc. -1
means follow the entire closure of the graph.propertyNames
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.propertyTypes
- Indicates whether to resolve only specific property categories,
regardless of the assigned name. Any of the enumerated PropertyType
values can be specified. If not empty and not null, only
properties matching the given types are included for resolved
nodes.sortOptions
- List of sort options to apply during resolution. If supplied,
the sort algorithms will be applied in the order provided. Any
algorithms not valid to be applied in context of node set
iteration, as specified in the sort extension description,
will result in a parameter exception. Available algorithms can
be retrieved through the LexBIGService getSortExtensions()
method after being defined to the LexBIGServiceManager
extension registry.filterOptions
- List of Filter extensions to apply during resolution. If
supplied, filters are applied in the order provided. Each name
in the list must correspond to the name of a Filter
description as registered to the associated service. Available
Filter descriptions can be retrieved through the LexBIGService
getFilterExtensions() method after being defined to the
LexBIGServiceManager extension registry.maxToReturn
- Maximum number of entries to return; a value less than 1
indicates to return unlimited entries (to the limit specified
in the runtime configuration file).
Note that while the class of the returned value appears to imply concepts only, each contained reference inherits from the more general CodedNodeReference and is capable of representing any type of node contained by the graph.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferenceList resolveAsList(ConceptReference graphFocus, boolean resolveForward, boolean resolveBackward, int resolveCodedEntryDepth, int resolveAssociationDepth, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, SortOptionList sortOptions, LocalNameList filterOptions, int maxToReturn, boolean keepLastAssociationLevelUnresolved) throws LBInvocationException, LBParameterException
graphFocus
- Set the top or "focus" node of the graph. If present, only
the nodes that are reachable via this node will be returned.
If null, nodes with no incoming or outgoing associations
are used as starting points for navigation of forward and
reverse relationships, respectively.resolveForward
- True means resolve in the direction of source to target.resolveBackward
- True means resolve in the direction of target to source.resolveCodedEntryDepth
- Depth in the graph to resolve coded entries. - 1 means don't
resolve anything - just return the code references, 0 means
resolve just the root nodes, 1 means resolve 1 deep, etc.resolveAssociationDepth
- Number of hops to resolve associations. 0 means leave all
associations unresolved, 1 means immediate neighbors, etc. -1
means follow the entire closure of the graph.propertyNames
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.propertyTypes
- Indicates whether to resolve only specific property categories,
regardless of the assigned name. Any of the enumerated PropertyType
values can be specified. If not empty and not null, only
properties matching the given types are included for resolved
nodes.sortOptions
- List of sort options to apply during resolution. If supplied,
the sort algorithms will be applied in the order provided. Any
algorithms not valid to be applied in context of node set
iteration, as specified in the sort extension description,
will result in a parameter exception. Available algorithms can
be retrieved through the LexBIGService getSortExtensions()
method after being defined to the LexBIGServiceManager
extension registry.filterOptions
- List of Filter extensions to apply during resolution. If
supplied, filters are applied in the order provided. Each name
in the list must correspond to the name of a Filter
description as registered to the associated service. Available
Filter descriptions can be retrieved through the LexBIGService
getFilterExtensions() method after being defined to the
LexBIGServiceManager extension registry.maxToReturn
- Maximum number of entries to return; a value less than 1
indicates to return unlimited entries (to the limit specified
in the runtime configuration file).keepLastAssociationLevelUnresolved
- Keep the last hop while resolving associations to the resolveAssociationDepth
unresolved. This is useful while drawing trees of an ontology and we need a
quick way to tell if the tree can be expanded further.
Note that while the class of the returned value appears to imply concepts only, each contained reference inherits from the more general CodedNodeReference and is capable of representing any type of node contained by the graph.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph restrictToAssociations(NameAndValueList association, NameAndValueList associationQualifiers) throws LBInvocationException, LBParameterException
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.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph restrictToDirectionalNames(NameAndValueList directionalNames, NameAndValueList associationQualifiers) throws LBInvocationException, LBParameterException
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.
LBInvocationException
- ,LBParameterException
LBParameterException
CodedNodeGraph restrictToCodes(CodedNodeSet codes) throws LBInvocationException, LBParameterException
codes
- Codes to filter on.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph restrictToCodeSystem(java.lang.String codingScheme) throws LBInvocationException, LBParameterException
codingScheme
- The local name or URI of the coding scheme to filter on.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph restrictToSourceCodes(CodedNodeSet codes) throws LBInvocationException, LBParameterException
codes
- Codes to filter on.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph restrictToSourceCodeSystem(java.lang.String codingScheme) throws LBInvocationException, LBParameterException
codingScheme
- The local name or URI of the coding scheme to filter on.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph restrictToTargetCodes(CodedNodeSet codes) throws LBInvocationException, LBParameterException
codes
- Codes to filter on.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph restrictToTargetCodeSystem(java.lang.String codingScheme) throws LBInvocationException, LBParameterException
codingScheme
- The local name or URI of the coding scheme to filter on.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph restrictToEntityTypes(LocalNameList localNameList) throws LBInvocationException, LBParameterException
localNameList
- the local name list
LBInvocationException
- the LB invocation exception
LBParameterException
- the LB parameter exceptionCodedNodeGraph restrictToAnonymous(java.lang.Boolean restrictToAnonymous) throws LBInvocationException, LBParameterException
localNameList
- the local name list
LBInvocationException
- the LB invocation exception
LBParameterException
- the LB parameter exceptionCodedNodeSet toNodeList(ConceptReference graphFocus, boolean resolveForward, boolean resolveBackward, int resolveAssociationDepth, int maxToReturn) throws LBInvocationException, LBParameterException
graphFocus
- Set the top or "focus" node of the graph. If present, only
the nodes that are reachable via this node will be returned.
If null, nodes with no incoming or outgoing associations
are used as starting points for navigation of forward and
reverse relationships, respectively.resolveForward
- True means include all "forward" (source->target)
associations.resolveBackward
- True means render all "reverse" (target->source) associationsresolveAssociationDepth
- Number of hops to resolve associations. 0 means leave all
associations unresolved, 1 means immediate neighbors, etc. -1
means follow the entire closure of the graph.maxToReturn
- Maximum number of entries to return; a value less than 1
indicates to return unlimited entries (to the limit specified
in the runtime configuration file).
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeGraph union(CodedNodeGraph graph) throws LBInvocationException, LBParameterException
graph
- Identifies the CodedNodeGraph to merge with.
LBInvocationException,LBParameterException
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |