Page History

LexEVS GraphResolve Final Proposal

Final Proposal Description and Sign Off

Method Signature

public List<ResolvedConceptReference> getAssociatedConcepts(CodedNodeSet cns, Direction direction, int depth,  NameAndValueList association);

Parameters:

Parameter cns: This CodedNodeSet must have a set of restrictions appropriate for query building and fully ready to be resolved. Cannot be null

Parameter direction: incoming or outgoing edges will be designated by one of these Enumerations.  Cannot be null

Parameter depth: This allows depth control of the query including resolving only neighbors or a full resolution if depth is known. Entering -1 allows full resolution,  0 will return null

Parameter associations: The name or names of the edges in the graph (Must exist as a supported association the code system).  Null returns all associations

Return Value List<ResolvedConceptReference>: a list of minimally populated concept references including code, namespace, 

entity description and coding scheme uri and version. These objects are the result of a graph resolution without 

any indication of where they existed in the graph before the resolution.

Method Behavior

This method requires some knowledge of building queries into the LexEVS system's CodedNodeSet API, including the capability

of building a CodedNodeSet set of restrictions through restriction method calls.  Within the scope of this method, 

the CodedNodeSet will be resolved to a ResolvedConceptReferenceList  using the method 

resolveToList(

SortOptionList sortOptions, LocalNameList propertyNames,

PropertyType[] propertyTypes, int maxToReturn)

throws LBInvocationException,LBParameterException;

The parameter set for this method will be defaulted to the following: 

SortOptionList: null – No sort options allowed

LocalNameList: null – No restrictions on property names

PropertyType: null – No restrictions on property types

int: 10 Maximum return limited to ten entities.

Null value for associations will return values for all associations.  Otherwise queries will be generated depending on each

association name.

Exceptions would be handled in this method and an appropriately messaged RuntimeException would be thrown on failure.

The ResolvedConceptReference objects returned contain only the code, name space, entityDescription, coding scheme URI, and coding scheme version.

It will not contain any entities or their properties or targetOf or sourceOf links to other entities.   

getAssociatedConcepts Proposal Signoff

LexEVS GraphResolve Legacy Requirements and Knowledge Base

Use Case/Requirements Statement:

...

Timeline for LexEVS Graph Service Design Discussion and Implementation.docx

Final Proposal Description and Sign Off

Parameters:

Parameter cns: This CodedNodeSet must have a set of restrictions appropriate for query building and fully ready to be resolved. Cannot be null

Parameter direction: incoming or outgoing edges will be designated by one of these Enumerations.  Cannot be null

Parameter depth: This allows depth control of the query including resolving only neighbors or a full resolution if depth is known. Entering -1 allows full resolution,  0 will return null

Parameter associations: The name or names of the edges in the graph (Must exist as a supported association the code system).  Null returns all associations

Return Value List<ResolvedConceptReference>: a list of minimally populated concept references including code, namespace, 

entity description and coding scheme uri and version. These objects are the result of a graph resolution without 

any indication of where they existed in the graph before the resolution.

Method Behavior

This method requires some knowledge of building queries into the LexEVS system's CodedNodeSet API, including the capability

of building a CodedNodeSet set of restrictions through restriction method calls.  Within the scope of this method, 

the CodedNodeSet will be resolved to a ResolvedConceptReferenceList  using the method 

resolveToList(

SortOptionList sortOptions, LocalNameList propertyNames,

PropertyType[] propertyTypes, int maxToReturn)

throws LBInvocationException,LBParameterException;

The parameter set for this method will be defaulted to the following: 

SortOptionList: null – No sort options allowed

LocalNameList: null – No restrictions on property names

PropertyType: null – No restrictions on property types

int: 10 Maximum return limited to ten entities.

Null value for associations will return values for all associations.  Otherwise queries will be generated depending on each

association name.

Exceptions would be handled in this method and an appropriately messaged RuntimeException would be thrown on failure.

The ResolvedConceptReference objects returned contain only the code, name space, entityDescription, coding scheme URI, and coding scheme version.

It will not contain any entities or their properties or targetOf or sourceOf links to other entities.   

Method Signature

...

getAssociatedConcepts Proposal Signoff

...