public class CodedNodeSetImpl extends java.lang.Object implements CodedNodeSet, java.lang.Cloneable
Modifier and Type | Class and Description |
---|---|
static class |
CodedNodeSetImpl.QueryBuilder
A holder for all
Restriction s set on this CodedNodeSetImpl that
can be converted into a Lucene Query on demand. |
CodedNodeSet.ActiveOption, CodedNodeSet.AnonymousOption, CodedNodeSet.PropertyType, CodedNodeSet.SearchDesignationOption
Modifier and Type | Field and Description |
---|---|
protected CodeHolderFactory |
codeHolderFactory |
Constructor and Description |
---|
CodedNodeSetImpl()
This constructor is only here for Apache Axis to work correctly.
|
CodedNodeSetImpl(CodeHolder codes,
java.lang.String internalCodingSchemeName,
java.lang.String internalVersionString)
This is used when I converter a CodedNodeGraph to a CodedNodeSet.
|
CodedNodeSetImpl(java.lang.String codingScheme,
CodingSchemeVersionOrTag tagOrVersion,
java.lang.Boolean activeOnly,
LocalNameList entityTypes) |
Modifier and Type | Method and Description |
---|---|
CodedNodeSetImpl |
clone() |
protected CodeToReturn |
convertConceptReferenceToCodeHolder(ConceptReference cr) |
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.
|
protected ConceptReferenceList |
getCleanedCodeList(ConceptReferenceList codeList) |
CodeHolderFactory |
getCodeHolderFactory() |
java.util.Set<CodingSchemeReference> |
getCodingSchemeReferences() |
protected LgLoggerIF |
getLogger() |
DefaultCodeHolder |
getNonEntityConceptReferenceList() |
CodedNodeSetImpl.QueryBuilder |
getQuery() |
protected ResolvedConceptReferencesIterator |
getResolvedConceptReferencesIterator(CodeHolder codesToInclude,
LocalNameList restrictToProperties,
CodedNodeSet.PropertyType[] restrictToPropertyTypes,
Filter[] filters,
boolean resolveObjects) |
protected <T> ResultComparator<T> |
getResultComparator(SortOptionList sortOptionList,
SortContext sortContext,
java.lang.Class<T> clazz) |
CodeHolder |
getToNodeListCodes() |
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.
|
boolean |
isShouldCodingSchemeSpecificRestriction() |
ResolvedConceptReferencesIterator |
resolve(SortOptionList sortOptions,
LocalNameList restrictToProperties,
CodedNodeSet.PropertyType[] restrictToPropertyTypes)
Resolve an iterator over nodes matching the given criteria.
|
ResolvedConceptReferencesIterator |
resolve(SortOptionList sortByProperty,
LocalNameList filterOptions,
LocalNameList restrictToProperties,
CodedNodeSet.PropertyType[] restrictToPropertyTypes)
Resolve an iterator over nodes matching the given criteria,
allowing for additional filters to be applied against the returned items.
|
ResolvedConceptReferencesIterator |
resolve(SortOptionList sortByProperty,
LocalNameList filterOptions,
LocalNameList restrictToProperties,
CodedNodeSet.PropertyType[] restrictToPropertyTypes,
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 restrictToProperties,
CodedNodeSet.PropertyType[] restrictToPropertyTypes,
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 sortByProperty,
LocalNameList filterOptions,
LocalNameList restrictToProperties,
CodedNodeSet.PropertyType[] restrictToPropertyTypes,
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 sortByProperty,
LocalNameList filterOptions,
LocalNameList restrictToProperties,
CodedNodeSet.PropertyType[] restrictToPropertyTypes,
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 |
restrictToAnonymous(CodedNodeSet.AnonymousOption anonymousOption)
Restrict the set to anonymous (or non-anonymous) nodes.
|
CodedNodeSet |
restrictToCodes(ConceptReferenceList codeList)
Restrict the set to the list of codes in the supplied reference
list
|
protected CodedNodeSet |
restrictToEntityTypes(LocalNameList typeList) |
CodedNodeSet |
restrictToMappingCodes(ConceptReferenceList codeList) |
CodedNodeSet |
restrictToMatchingDesignations(java.lang.String matchText,
boolean preferredOnly,
java.lang.String matchAlgorithm,
java.lang.String language)
Deprecated.
|
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 propertyList,
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 propertyList,
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[] conceptStatus)
Restrict the set to nodes matching the given status criteria.
|
void |
setCodeHolderFactory(CodeHolderFactory codeHolderFactory) |
void |
setNonEntityConceptReferenceList(DefaultCodeHolder nonEntityConceptReferenceList) |
void |
setShouldCodingSchemeSpecificRestriction(boolean shouldCodingSchemeSpecificRestriction) |
protected CodeHolder |
toBruteForceMode() |
CodedNodeSet |
union(CodedNodeSet codes)
Return the set union of all of the codes in the containing or the
referenced set
|
protected CodeHolderFactory codeHolderFactory
public CodedNodeSetImpl()
public CodedNodeSetImpl(java.lang.String codingScheme, CodingSchemeVersionOrTag tagOrVersion, java.lang.Boolean activeOnly, LocalNameList entityTypes) throws LBInvocationException, LBParameterException, LBResourceUnavailableException
public CodedNodeSetImpl(CodeHolder codes, java.lang.String internalCodingSchemeName, java.lang.String internalVersionString) throws LBInvocationException
codes
- LBInvocationException
LBParameterException
protected LgLoggerIF getLogger()
public CodedNodeSet intersect(CodedNodeSet codes) throws LBInvocationException, LBParameterException
CodedNodeSet
intersect
in interface CodedNodeSet
codes
- Set of codes to intersect.LBInvocationException
LBParameterException
CodedNodeSet.intersect(org.LexGrid.LexBIG.LexBIGService.CodedNodeSet)
public CodedNodeSet union(CodedNodeSet codes) throws LBInvocationException, LBParameterException
CodedNodeSet
union
in interface CodedNodeSet
codes
- Codes to add to the unionLBInvocationException
LBParameterException
CodedNodeSet.union(org.LexGrid.LexBIG.LexBIGService.CodedNodeSet)
public CodedNodeSet difference(CodedNodeSet codesToRemove) throws LBInvocationException, LBParameterException
CodedNodeSet
difference
in interface CodedNodeSet
codesToRemove
- List of codes to remove from the surrounding set.LBInvocationException
LBParameterException
CodedNodeSet.difference(org.LexGrid.LexBIG.LexBIGService.CodedNodeSet)
public java.lang.Boolean isCodeInSet(ConceptReference code) throws LBInvocationException, LBParameterException
CodedNodeSet
isCodeInSet
in interface CodedNodeSet
code
- Coding scheme and code to test.LBInvocationException
LBParameterException
CodedNodeSet.isCodeInSet(org.LexGrid.LexBIG.DataModel.Core.ConceptReference)
@Deprecated public CodedNodeSet restrictToMatchingDesignations(java.lang.String matchText, boolean preferredOnly, java.lang.String matchAlgorithm, java.lang.String language) throws LBInvocationException, LBParameterException
CodedNodeSet
restrictToMatchingDesignations
in interface CodedNodeSet
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
CodedNodeSet.restrictToMatchingDesignations(String,
boolean, String, String)
public CodedNodeSet restrictToMatchingDesignations(java.lang.String matchText, CodedNodeSet.SearchDesignationOption option, java.lang.String matchAlgorithm, java.lang.String language) throws LBInvocationException, LBParameterException
CodedNodeSet
restrictToMatchingDesignations
in interface CodedNodeSet
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
public CodedNodeSet restrictToProperties(LocalNameList propertyList, CodedNodeSet.PropertyType[] propertyTypes, LocalNameList sourceList, LocalNameList contextList, NameAndValueList qualifierList) throws LBInvocationException, LBParameterException
CodedNodeSet
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.
restrictToProperties
in interface CodedNodeSet
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
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet#restrictToProperties(org.LexGrid.LexBIG.DataModel.Collections.PropertyDetailList)
public CodedNodeSet restrictToProperties(LocalNameList propertyList, CodedNodeSet.PropertyType[] propertyTypes) throws LBInvocationException, LBParameterException
CodedNodeSet
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.
restrictToProperties
in interface CodedNodeSet
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
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet#restrictToProperties(org.LexGrid.LexBIG.DataModel.Collections.LocalNameList)
public CodedNodeSet restrictToCodes(ConceptReferenceList codeList) throws LBInvocationException, LBParameterException
CodedNodeSet
restrictToCodes
in interface CodedNodeSet
codeList
- The list of codes to filter on.LBInvocationException
LBParameterException
public CodedNodeSet restrictToMappingCodes(ConceptReferenceList codeList) throws LBParameterException, LBInvocationException
restrictToMappingCodes
in interface CodedNodeSet
codeList
- is the list of concepts to restrict toLBParameterException
LBInvocationException
protected ConceptReferenceList getCleanedCodeList(ConceptReferenceList codeList)
protected CodeToReturn convertConceptReferenceToCodeHolder(ConceptReference cr)
protected CodedNodeSet restrictToEntityTypes(LocalNameList typeList) throws LBInvocationException, LBParameterException
public CodedNodeSet restrictToMatchingProperties(LocalNameList propertyList, CodedNodeSet.PropertyType[] propertyTypes, LocalNameList sourceList, LocalNameList contextList, NameAndValueList qualifierList, java.lang.String matchText, java.lang.String matchAlgorithm, java.lang.String language) throws LBInvocationException, LBParameterException
CodedNodeSet
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.
restrictToMatchingProperties
in interface CodedNodeSet
propertyList
- 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
public CodedNodeSet restrictToMatchingProperties(LocalNameList propertyList, CodedNodeSet.PropertyType[] propertyTypes, java.lang.String matchText, java.lang.String matchAlgorithm, java.lang.String language) throws LBInvocationException, LBParameterException
CodedNodeSet
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.
restrictToMatchingProperties
in interface CodedNodeSet
propertyList
- 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
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet#restrictToMatchingProperties(org.LexGrid.LexBIG.DataModel.Collections.LocalNameList,
String, String, String)
public ResolvedConceptReferenceList resolveToList(SortOptionList sortOptions, LocalNameList restrictToProperties, CodedNodeSet.PropertyType[] restrictToPropertyTypes, int maxToReturn) throws LBInvocationException, LBParameterException
CodedNodeSet
resolveToList
in interface CodedNodeSet
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.restrictToProperties
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.restrictToPropertyTypes
- 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
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet#resolveToList(org.LexGrid.LexBIG.DataModel.Collections.SortOptionList,
org.LexGrid.LexBIG.DataModel.Collections.LocalNameList, int)
public ResolvedConceptReferenceList resolveToList(SortOptionList sortByProperty, LocalNameList filterOptions, LocalNameList restrictToProperties, CodedNodeSet.PropertyType[] restrictToPropertyTypes, int maxToReturn) throws LBInvocationException, LBParameterException
CodedNodeSet
resolveToList
in interface CodedNodeSet
sortByProperty
- 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.restrictToProperties
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.restrictToPropertyTypes
- 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
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet#resolveToList(org.LexGrid.LexBIG.DataModel.Collections.SortOptionList,
org.LexGrid.LexBIG.DataModel.Collections.LocalNameList,
org.LexGrid.LexBIG.DataModel.Collections.LocalNameList, int)
public ResolvedConceptReferenceList resolveToList(SortOptionList sortByProperty, LocalNameList filterOptions, LocalNameList restrictToProperties, CodedNodeSet.PropertyType[] restrictToPropertyTypes, boolean resolveObjects, int maxToReturn) throws LBInvocationException, LBParameterException
CodedNodeSet
resolveToList
in interface CodedNodeSet
sortByProperty
- 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.restrictToProperties
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.restrictToPropertyTypes
- 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
protected <T> ResultComparator<T> getResultComparator(SortOptionList sortOptionList, SortContext sortContext, java.lang.Class<T> clazz) throws LBParameterException
LBParameterException
public ResolvedConceptReferencesIterator resolve(SortOptionList sortOptions, LocalNameList restrictToProperties, CodedNodeSet.PropertyType[] restrictToPropertyTypes) throws LBInvocationException, LBParameterException
CodedNodeSet
resolve
in interface CodedNodeSet
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.restrictToProperties
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.restrictToPropertyTypes
- 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
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet#resolve(org.LexGrid.LexBIG.DataModel.Collections.LocalNameList,
org.LexGrid.LexBIG.DataModel.Collections.LocalNameList)
public ResolvedConceptReferencesIterator resolve(SortOptionList sortByProperty, LocalNameList filterOptions, LocalNameList restrictToProperties, CodedNodeSet.PropertyType[] restrictToPropertyTypes) throws LBInvocationException, LBParameterException
CodedNodeSet
resolve
in interface CodedNodeSet
sortByProperty
- 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.restrictToProperties
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.restrictToPropertyTypes
- 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
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet#resolve(org.LexGrid.LexBIG.DataModel.Collections.SortOptionList,
org.LexGrid.LexBIG.DataModel.Collections.LocalNameList,
org.LexGrid.LexBIG.DataModel.Collections.LocalNameList)
public ResolvedConceptReferencesIterator resolve(SortOptionList sortByProperty, LocalNameList filterOptions, LocalNameList restrictToProperties, CodedNodeSet.PropertyType[] restrictToPropertyTypes, boolean resolveObjects) throws LBInvocationException, LBParameterException
CodedNodeSet
resolve
in interface CodedNodeSet
sortByProperty
- 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.restrictToProperties
- Local names of properties to resolve. If not empty and not
null, only properties matching the given names are included
for resolved nodes.restrictToPropertyTypes
- 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
org.LexGrid.LexBIG.LexBIGService.CodedNodeSet#resolve(org.LexGrid.LexBIG.DataModel.Collections.SortOptionList,
org.LexGrid.LexBIG.DataModel.Collections.LocalNameList,
org.LexGrid.LexBIG.DataModel.Collections.LocalNameList)
public CodedNodeSet restrictToStatus(CodedNodeSet.ActiveOption activeOption, java.lang.String[] conceptStatus) throws LBInvocationException, LBParameterException
CodedNodeSet
restrictToStatus
in interface CodedNodeSet
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.conceptStatus
- 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
CodedNodeSet.restrictToStatus(org.LexGrid.LexBIG.LexBIGService.CodedNodeSet.ActiveOption,
java.lang.String[])
public CodedNodeSet restrictToAnonymous(CodedNodeSet.AnonymousOption anonymousOption) throws LBInvocationException, LBParameterException
CodedNodeSet
restrictToAnonymous
in interface CodedNodeSet
anonymousOption
- AnonymousOption.ANONYMOUS_ONLY : Only Anonymous nodes
AnonymousOption.NON_ANONYMOUS_ONLY : Only nodes that are either not anonymous, or unspecified
AnonymousOption.ALL : All nodesLBInvocationException
- the LB invocation exceptionLBParameterException
- the LB parameter exceptionprotected ResolvedConceptReferencesIterator getResolvedConceptReferencesIterator(CodeHolder codesToInclude, LocalNameList restrictToProperties, CodedNodeSet.PropertyType[] restrictToPropertyTypes, Filter[] filters, boolean resolveObjects)
protected CodeHolder toBruteForceMode() throws LBException, InternalException
LBException
InternalException
public CodedNodeSetImpl clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public java.util.Set<CodingSchemeReference> getCodingSchemeReferences()
public CodeHolderFactory getCodeHolderFactory()
public void setCodeHolderFactory(CodeHolderFactory codeHolderFactory)
public CodeHolder getToNodeListCodes()
public void setShouldCodingSchemeSpecificRestriction(boolean shouldCodingSchemeSpecificRestriction)
public boolean isShouldCodingSchemeSpecificRestriction()
public CodedNodeSetImpl.QueryBuilder getQuery()
public DefaultCodeHolder getNonEntityConceptReferenceList()
public void setNonEntityConceptReferenceList(DefaultCodeHolder nonEntityConceptReferenceList)