|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CodedNodeSet
A coded node set represents a flat list of coded entries.
Nested Class Summary | |
---|---|
static class |
CodedNodeSet.ActiveOption
|
static class |
CodedNodeSet.PropertyType
|
static class |
CodedNodeSet.SearchDesignationOption
|
Method Summary | |
---|---|
CodedNodeSet |
difference(CodedNodeSet codesToRemove)
Return a coded node set that represents the set of nodes in this set that are not included by the given set. |
CodedNodeSet |
intersect(CodedNodeSet codes)
Return a coded node set that represents the set of nodes this set and the provided node set have in common. |
java.lang.Boolean |
isCodeInSet(ConceptReference code)
Return true if the supplied code reference is contained within this coded node set. |
ResolvedConceptReferencesIterator |
resolve(SortOptionList sortOptions,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes)
Resolve an iterator over nodes matching the given criteria. |
ResolvedConceptReferencesIterator |
resolve(SortOptionList sortOptions,
LocalNameList filterOptions,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes)
Resolve an iterator over nodes matching the given criteria, allowing for additional filters to be applied against the returned items. |
ResolvedConceptReferencesIterator |
resolve(SortOptionList sortOptions,
LocalNameList filterOptions,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
boolean resolveObjects)
Resolve an iterator over nodes matching the given criteria, allowing for additional filters and optionally populating full objects (e.g. concept or instance) for each returned reference. |
ResolvedConceptReferenceList |
resolveToList(SortOptionList sortOptions,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
int maxToReturn)
Resolve the set to a list of nodes sorted by the supplied parameters, resolving all of the properties named in the list. |
ResolvedConceptReferenceList |
resolveToList(SortOptionList sortOptions,
LocalNameList filterOptions,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
boolean resolveObjects,
int maxToReturn)
Resolve the set to a list of nodes sorted by the supplied parameters, resolving all of the properties named in the list, and allowing for additional filters to be applied against the returned items. |
ResolvedConceptReferenceList |
resolveToList(SortOptionList sortOptions,
LocalNameList filterOptions,
LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
int maxToReturn)
Resolve the set to a list of nodes sorted by the supplied parameters, resolving all of the properties named in the list, and allowing for additional filters to be applied against the returned items. |
CodedNodeSet |
restrictToCodes(ConceptReferenceList codeList)
Restrict the set to the list of codes in the supplied reference list |
CodedNodeSet |
restrictToMatchingDesignations(java.lang.String matchText,
boolean preferredOnly,
java.lang.String matchAlgorithm,
java.lang.String language)
Deprecated. see restrictToMatchingDesignations(String, SearchDesignationOption, String, String) |
CodedNodeSet |
restrictToMatchingDesignations(java.lang.String matchText,
CodedNodeSet.SearchDesignationOption option,
java.lang.String matchAlgorithm,
java.lang.String language)
Restrict the list to the set of nodes with designations matching the supplied text, interpreted using the supplied matching algorithm and language. |
CodedNodeSet |
restrictToMatchingProperties(LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
LocalNameList sourceList,
LocalNameList contextList,
NameAndValueList qualifierList,
java.lang.String matchText,
java.lang.String matchAlgorithm,
java.lang.String language)
Remove all elements from the set that do not have one or more properties that match the given criteria. |
CodedNodeSet |
restrictToMatchingProperties(LocalNameList propertyNames,
CodedNodeSet.PropertyType[] propertyTypes,
java.lang.String matchText,
java.lang.String matchAlgorithm,
java.lang.String language)
Remove all elements from the set that do not have one or more properties that match the supplied property names, type, and text. |
CodedNodeSet |
restrictToProperties(LocalNameList propertyList,
CodedNodeSet.PropertyType[] propertyTypes)
Remove all elements from the set that do not have one or more properties that match the supplied property list. |
CodedNodeSet |
restrictToProperties(LocalNameList propertyList,
CodedNodeSet.PropertyType[] propertyTypes,
LocalNameList sourceList,
LocalNameList contextList,
NameAndValueList qualifierList)
Remove all elements from the set that do not have one or more properties that match the given criteria. |
CodedNodeSet |
restrictToStatus(CodedNodeSet.ActiveOption activeOption,
java.lang.String[] status)
Restrict the set to nodes matching the given status criteria. |
CodedNodeSet |
union(CodedNodeSet codes)
Return the set union of all of the codes in the containing or the referenced set |
Method Detail |
---|
CodedNodeSet difference(CodedNodeSet codesToRemove) throws LBInvocationException, LBParameterException
codesToRemove
- List of codes to remove from the surrounding set.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet intersect(CodedNodeSet codes) throws LBInvocationException, LBParameterException
codes
- Set of codes to intersect.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
java.lang.Boolean isCodeInSet(ConceptReference code) throws LBInvocationException, LBParameterException
code
- Coding scheme and code to test.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferencesIterator resolve(SortOptionList sortOptions, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes) throws LBInvocationException, LBParameterException
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.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.
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 set.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferencesIterator resolve(SortOptionList sortOptions, LocalNameList filterOptions, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes) throws LBInvocationException, LBParameterException
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.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.
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 set.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferencesIterator resolve(SortOptionList sortOptions, LocalNameList filterOptions, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, boolean resolveObjects) throws LBInvocationException, LBParameterException
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.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.resolveObjects
- True to build and embed a full object (e.g. concept) for each
referenced node in the returned results; false to return only
basic identifying information (e.g. code, coding scheme,
and description). If false, additional properties for referenced
entries can be resolved on an item-by-item basis as controlled
by the application.
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 set.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferenceList resolveToList(SortOptionList sortOptions, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, int maxToReturn) throws LBInvocationException, LBParameterException
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.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.maxToReturn
- Maximum number of entries to return.
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 set.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferenceList resolveToList(SortOptionList sortOptions, LocalNameList filterOptions, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, int maxToReturn) throws LBInvocationException, LBParameterException
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.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.maxToReturn
- Maximum number of entries to return.
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 set.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
ResolvedConceptReferenceList resolveToList(SortOptionList sortOptions, LocalNameList filterOptions, LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, boolean resolveObjects, int maxToReturn) throws LBInvocationException, LBParameterException
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.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.resolveObjects
- True to build and embed a full object (e.g. concept) for each
referenced node in the returned results; false to return only
basic identifying information (e.g. code, coding scheme,
and description). If false, additional properties for referenced
entries can be resolved on an item-by-item basis as controlled
by the application.maxToReturn
- Maximum number of entries to return.
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 set.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet restrictToCodes(ConceptReferenceList codeList) throws LBInvocationException, LBParameterException
codeList
- The list of codes to filter on.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet restrictToMatchingDesignations(java.lang.String matchText, boolean preferredOnly, java.lang.String matchAlgorithm, java.lang.String language) throws LBInvocationException, LBParameterException
matchText
- Filter String - syntax is determined by the match algorithmpreferredOnly
- True means only use preferred designations, false means all.matchAlgorithm
- Local name of the match algorithm - possible algorithms are
returned in LexBigService.getMatchAlgorithms().language
- Language of search string. If missing, use the default
language specified in the context.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet restrictToMatchingDesignations(java.lang.String matchText, CodedNodeSet.SearchDesignationOption option, java.lang.String matchAlgorithm, java.lang.String language) throws LBInvocationException, LBParameterException
matchText
- Filter String - syntax is determined by the match algorithmoption
- Indicates the designations to search (one of the enumerated
type SearchDesignationOption).matchAlgorithm
- Local name of the match algorithm - possible algorithms are
returned in LexBigService.getMatchAlgorithms().language
- Language of search string. If missing, use the default
language specified in the context.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet restrictToMatchingProperties(LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, java.lang.String matchText, java.lang.String matchAlgorithm, java.lang.String language) throws LBInvocationException, LBParameterException
Note that while property name and type can be the same, the API allows for them to differ. While property name can vary from source to source, all properties are mapped to normalized property types or categories as established by the LexGrid model ('Presentations', 'Definitions', 'Comments', and 'Generic' properties). As an example, a Presentation property may be named 'displayText').
This method allows for query based on property name, type, or both. However, at least one name or type must be specified.
propertyNames
- Indicates the local names of properties to match. To be recognized,
each provided name must be defined in the coding scheme metadata as
part of the registered supported properties. If empty or null,
all names are evaluated for the specified property types.
Note that the meta-property 'conceptCode' can be specified in addition to specific named properties defined by the code system.
If 'conceptCode' is specified, the matchAlgorithms 'exactMatch', 'contains' and 'luceneQuery' are allowed. Any other request results in 'luceneQuery' being used.
propertyTypes
- Indicates whether to match specific property categories, regardless
of the assigned name. Any of the enumerated PropertyType values
can be specified. If empty or null, properties of all types are
evaluated.matchText
- Property text to match - syntax is determined by the
algorithm.matchAlgorithm
- Local name of the match algorithm - possible algorithms are
returned in LexBigService.getMatchAlgorithms().language
- Language of search string. If missing, use the default
language specified in the context.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet restrictToMatchingProperties(LocalNameList propertyNames, CodedNodeSet.PropertyType[] propertyTypes, LocalNameList sourceList, LocalNameList contextList, NameAndValueList qualifierList, java.lang.String matchText, java.lang.String matchAlgorithm, java.lang.String language) throws LBInvocationException, LBParameterException
Note that while property name and type can be the same, the API allows for them to differ. While property name can vary from source to source, all properties are mapped to normalized property types or categories as established by the LexGrid model ('Presentations', 'Definitions', 'Comments', and 'Generic' properties). As an example, a Presentation property may be named 'displayText').
This method allows for query based on property name, type, or both. However, at least one name or type must be specified.
propertyNames
- Indicates the local names of properties to match. To be recognized,
each provided name must be defined in the coding scheme metadata as
part of the registered supported properties. If empty or null,
all names are evaluated for the specified property types.
Note that the meta-property 'conceptCode' can be specified in addition to specific named properties defined by the code system.
If 'conceptCode' is specified, the matchAlgorithms 'exactMatch', 'contains' and 'luceneQuery' and 'RegExp' are allowed. Any other request results in 'luceneQuery' being used.
propertyTypes
- Indicates whether to match specific property categories, regardless
of the assigned name. Any of the enumerated PropertyType values
can be specified. If empty or null, properties of all types are
evaluated.sourceList
- Local names of sources to match; each must be defined in the
supported sources for the coding scheme. Returned values must
match at least one of the specified values. A null or empty
value indicates to match against all available sources.contextList
- Local names of usage contexts to match; each must be defined
in the supported contexts for the coding scheme. Returned
values must match at least one of the specified values. A null
or empty value indicates to match against all available
contexts.qualifierList
- Name/value pairings of property qualifiers to match. Each name
must be defined in the supported property qualifiers for the
coding scheme. Returned values must match at least one of the
name/value combinations. A null or empty value indicates to
match against all property qualifiers.matchText
- Property text to match - syntax is determined by the
algorithm.matchAlgorithm
- Local name of the match algorithm - possible algorithms are
returned in LexBigService.getMatchAlgorithms().language
- Language of search string. If missing, use the default
language specified in the context.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet restrictToProperties(LocalNameList propertyList, CodedNodeSet.PropertyType[] propertyTypes) throws LBInvocationException, LBParameterException
Note that while property name and type can be the same, the API allows for them to differ. While property name can vary from source to source, all properties are mapped to normalized property types or categories as established by the LexGrid model ('Presentations', 'Definitions', 'Comments', and 'Generic' properties). As an example, a Presentation property may be named 'displayText').
This method allows for query based on property name, type, or both. However, at least one name or type must be specified.
propertyList
- Local names of properties to use in restriction; each must be
defined in the supported properties for the coding scheme.propertyTypes
- Indicates whether to match specific property categories, regardless
of the assigned name. Any of the enumerated PropertyType values
can be specified. If empty or null, properties of all types are
evaluated.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet restrictToProperties(LocalNameList propertyList, CodedNodeSet.PropertyType[] propertyTypes, LocalNameList sourceList, LocalNameList contextList, NameAndValueList qualifierList) throws LBInvocationException, LBParameterException
Note that while property name and type can be the same, the API allows for them to differ. While property name can vary from source to source, all properties are mapped to normalized property types or categories as established by the LexGrid model ('Presentations', 'Definitions', 'Comments', and 'Generic' properties). As an example, a Presentation property may be named 'displayText').
This method allows for query based on property name, type, or both. However, at least one name or type must be specified.
propertyList
- Local names of properties to use in restriction; each must be
defined in the supported properties for the coding scheme.propertyTypes
- Indicates whether to match specific property categories, regardless
of the assigned name. Any of the enumerated PropertyType values
can be specified. If empty or null, properties of all types are
evaluated.sourceList
- Local names of sources to match; each must be defined in the
supported sources for the coding scheme. Returned values must
match at least one of the specified values. A null or empty
value indicates to match against all available sources.contextList
- Local names of usage contexts to match; each must be defined
in the supported contexts for the coding scheme. Returned
values must match at least one of the specified values. A null
or empty value indicates to match against all available
contexts.qualifierList
- Name/value pairings of property qualifiers to match. Each name
must be defined in the supported property qualifiers for the
coding scheme. Returned values must match at least one of the
name/value combinations. A null or empty value indicates to
match against all property qualifiers.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet restrictToStatus(CodedNodeSet.ActiveOption activeOption, java.lang.String[] status) throws LBInvocationException, LBParameterException
activeOption
- Indicates whether to include active codes, inactive codes,
or both in the resolved result set (one of the enumerated type
ActiveOption). This is matched against the 'isActive' field for
CodedEntry instances in the code system.status
- Indicates zero or more status values to match. Provided
values are compared using an exact match algorithm against
the 'status' field for matching entities. If null or
empty, the restriction is evaluated based only on the
specified activeOption.
LBInvocationException,LBParameterException
LBInvocationException
LBParameterException
CodedNodeSet union(CodedNodeSet codes) throws LBInvocationException, LBParameterException
codes
- Codes to add to the union
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 |