|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CodedNodeSetGrid
A coded node set represents a flat list of coded entries.
Method Summary | |
---|---|
CodedNodeSetGrid |
difference(CodedNodeSetGrid codesToRemove)
Return a coded node set that represents the set of concepts in this coded node set that are not included by the given set of codes. |
CodedNodeSetGrid |
intersect(CodedNodeSetGrid codes)
Return a coded node set that represents the set of concepts that this node set and the provided node set have in common. |
CodeExistence |
isCodeInSet(ConceptReference code)
Return true if the supplied concept reference is contained within the represented list. |
ResolvedConceptReferencesIterator |
resolve(SetResolutionPolicy policy)
Resolve an iterator over concepts matching the given criteria. |
ResolvedConceptReferenceList |
resolveToList(SetResolutionPolicy policy)
Resolve the set to a list of concepts sorted by the supplied parameters, resolving all of the properties named in the list. |
CodedNodeSetGrid |
restrictToCodes(ConceptReferenceList codeList)
Restrict the set to the list of codes in the supplied conceptReference list |
CodedNodeSetGrid |
restrictToMatchingDesignations(MatchCriteria matchText,
SearchDesignationOption option,
ExtensionIdentification matchAlgorithm,
LanguageIdentification language)
Restrict the list to the set of concepts that have designations that match the supplied string, using the supplied matching algorithm and language |
CodedNodeSetGrid |
restrictToMatchingProperties(LocalNameList propertyNames,
PropertyType[] propertyTypes,
LocalNameList sourceList,
LocalNameList contextList,
NameAndValueList qualifierList,
MatchCriteria matchText,
ExtensionIdentification matchAlgorithm,
LanguageIdentification language)
Remove all elements from the set that do not have one or more properties that match the given criteria. |
CodedNodeSetGrid |
restrictToProperties(LocalNameList propertyList,
PropertyType[] propertyTypes,
LocalNameList sourceList,
LocalNameList contextList,
NameAndValueList qualifierList)
Remove all elements from the set that don't have one or more properties that match the given criteria. |
CodedNodeSetGrid |
restrictToStatus(ActiveOption activeOption,
Status[] conceptStatus)
Restrict the set to concepts matching the given status criteria. |
CodedNodeSetGrid |
union(CodedNodeSetGrid codes)
Return the set union of all of the codes in the containing or the referenced set |
Method Detail |
---|
CodedNodeSetGrid difference(CodedNodeSetGrid codesToRemove) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
codesToRemove
- List of codes to remove from the surrounding set.
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
CodedNodeSetGrid intersect(CodedNodeSetGrid codes) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
codes
- Set of codes to intersect.
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
CodeExistence isCodeInSet(ConceptReference code) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
code
- Coding scheme and concept code to test.
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
ResolvedConceptReferencesIterator resolve(SetResolutionPolicy policy) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
policy
- Policy for resolving the CodedNodeSet
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
ResolvedConceptReferenceList resolveToList(SetResolutionPolicy policy) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
policy
- Policy for resolving the relationship
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
CodedNodeSetGrid restrictToCodes(ConceptReferenceList codeList) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
codeList
- The list of codes to filter on.
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
CodedNodeSetGrid restrictToMatchingDesignations(MatchCriteria matchText, SearchDesignationOption option, ExtensionIdentification matchAlgorithm, LanguageIdentification language) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
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,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
CodedNodeSetGrid restrictToMatchingProperties(LocalNameList propertyNames, PropertyType[] propertyTypes, LocalNameList sourceList, LocalNameList contextList, NameAndValueList qualifierList, MatchCriteria matchText, ExtensionIdentification matchAlgorithm, LanguageIdentification language) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
Note that while property name and type are often synchronized, the API allows for them to be differentiated. For concepts, there are 5 major types of properties that can be assigned ('Comments', 'Definitions', 'Instructions', 'Presentations', and 'Generic' properties which can represent vocabulary-specific name/value pairings).
Often the name assigned to a property will match the property type (e.g. a Presentation named 'textualPresentation' or a Definition named 'definition'). However, names are not fixed (e.g. a Presentation property may be named 'text' or 'textualPresentation').
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,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
CodedNodeSetGrid restrictToProperties(LocalNameList propertyList, PropertyType[] propertyTypes, LocalNameList sourceList, LocalNameList contextList, NameAndValueList qualifierList) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
Note that while property name and type are often synchronized, the API allows for them to be differentiated. For concepts, there are 5 major types of properties that can be assigned ('Comments', 'Definitions', 'Instructions', 'Presentations', and 'Generic' properties which can represent vocabulary-specific name/value pairings).
Often the name assigned to a property will match the property type (e.g. a Presentation named 'textualPresentation' or a Definition named 'definition'). However, names are not fixed (e.g. a Presentation property may be named 'text' or 'textualPresentation').
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,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
CodedNodeSetGrid restrictToStatus(ActiveOption activeOption, Status[] conceptStatus) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
activeOption
- Indicates whether to include active concepts, inactive concepts,
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.conceptStatus
- Indicates zero or more concept status values to match. Provided
values are compared using an exact match algorithm against
the 'conceptStatus' field for CodedEntry instances in the code
system. If null or empty, the restriction is evaluated based only
on the specified activeOption.
LBInvocationException,LBParameterException,InvalidServiceContextAccess,RemoteException
LBInvocationException
LBParameterException
InvalidServiceContextAccess
java.rmi.RemoteException
CodedNodeSetGrid union(CodedNodeSetGrid codes) throws LBInvocationException, LBParameterException, InvalidServiceContextAccess, java.rmi.RemoteException
codes
- Codes to add to the union
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |