org.LexGrid.LexBIG.cagrid.adapters
Class CodedNodeSetGridAdapter

java.lang.Object
  extended by org.LexGrid.LexBIG.cagrid.adapters.CodedNodeSetGridAdapter
All Implemented Interfaces:
java.io.Serializable, CodedNodeSetGrid

public class CodedNodeSetGridAdapter
extends java.lang.Object
implements CodedNodeSetGrid

See Also:
Serialized Form

Constructor Summary
CodedNodeSetGridAdapter(CodedNodeSetClient client)
           
 
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.
 org.LexGrid.LexBIG.LexBIGService.CodedNodeSet getCodedNodeSetInterface()
           
 org.apache.axis.message.addressing.EndpointReferenceType getEndpointReference()
           
 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.
 org.LexGrid.LexBIG.DataModel.cagrid.CodeExistence isCodeInSet(org.LexGrid.LexBIG.DataModel.Core.ConceptReference code)
          Return true if the supplied concept reference is contained within the represented list.
 org.LexGrid.LexBIG.Utility.Iterators.ResolvedConceptReferencesIterator resolve(org.LexGrid.LexBIG.DataModel.cagrid.SetResolutionPolicy policy)
          Resolve an iterator over concepts matching the given criteria.
 org.LexGrid.LexBIG.DataModel.Collections.ResolvedConceptReferenceList resolveToList(org.LexGrid.LexBIG.DataModel.cagrid.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(org.LexGrid.LexBIG.DataModel.Collections.ConceptReferenceList codeList)
          Restrict the set to the list of codes in the supplied conceptReference list
 CodedNodeSetGrid restrictToMatchingDesignations(org.LexGrid.LexBIG.DataModel.cagrid.MatchCriteria matchText, org.LexGrid.LexBIG.DataModel.enums.SearchDesignationOption option, org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification matchAlgorithm, org.LexGrid.LexBIG.DataModel.cagrid.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(org.LexGrid.LexBIG.DataModel.Collections.LocalNameList propertyNames, org.LexGrid.LexBIG.DataModel.enums.PropertyType[] propertyTypes, org.LexGrid.LexBIG.DataModel.Collections.LocalNameList sourceList, org.LexGrid.LexBIG.DataModel.Collections.LocalNameList contextList, org.LexGrid.LexBIG.DataModel.Collections.NameAndValueList qualifierList, org.LexGrid.LexBIG.DataModel.cagrid.MatchCriteria matchText, org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification matchAlgorithm, org.LexGrid.LexBIG.DataModel.cagrid.LanguageIdentification language)
          Remove all elements from the set that do not have one or more properties that match the given criteria.
 CodedNodeSetGrid restrictToProperties(org.LexGrid.LexBIG.DataModel.Collections.LocalNameList propertyList, org.LexGrid.LexBIG.DataModel.enums.PropertyType[] propertyTypes, org.LexGrid.LexBIG.DataModel.Collections.LocalNameList sourceList, org.LexGrid.LexBIG.DataModel.Collections.LocalNameList contextList, org.LexGrid.LexBIG.DataModel.Collections.NameAndValueList qualifierList)
          Remove all elements from the set that don't have one or more properties that match the given criteria.
 CodedNodeSetGrid restrictToStatus(org.LexGrid.LexBIG.DataModel.enums.ActiveOption activeOption, org.LexGrid.LexBIG.DataModel.cagrid.Status[] status)
          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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CodedNodeSetGridAdapter

public CodedNodeSetGridAdapter(CodedNodeSetClient client)
                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException
Method Detail

difference

public CodedNodeSetGrid difference(CodedNodeSetGrid codesToRemove)
                            throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                   org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                   org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                   java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
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.

Specified by:
difference in interface CodedNodeSetGrid
Parameters:
codesToRemove - List of codes to remove from the surrounding set.
Returns:
A new CodedNodeSet containing the difference.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

intersect

public CodedNodeSetGrid intersect(CodedNodeSetGrid codes)
                           throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                  org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                  org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                  java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Return a coded node set that represents the set of concepts that this node set and the provided node set have in common.

Specified by:
intersect in interface CodedNodeSetGrid
Parameters:
codes - Set of codes to intersect.
Returns:
A new CodedNodeSet containing the intersection result.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

isCodeInSet

public org.LexGrid.LexBIG.DataModel.cagrid.CodeExistence isCodeInSet(org.LexGrid.LexBIG.DataModel.Core.ConceptReference code)
                                                              throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                                                     org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                                     org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                     java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Return true if the supplied concept reference is contained within the represented list.

Specified by:
isCodeInSet in interface CodedNodeSetGrid
Parameters:
code - Coding scheme and concept code to test.
Returns:
CodeExistence True if the concept is present; otherwise False.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

resolve

public org.LexGrid.LexBIG.Utility.Iterators.ResolvedConceptReferencesIterator resolve(org.LexGrid.LexBIG.DataModel.cagrid.SetResolutionPolicy policy)
                                                                               throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                                                                      org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                                                      org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                      java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Resolve an iterator over concepts matching the given criteria.

Specified by:
resolve in interface CodedNodeSetGrid
Parameters:
policy - Policy for resolving the CodedNodeSet
Returns:
An iterator over matching concepts.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

resolveToList

public org.LexGrid.LexBIG.DataModel.Collections.ResolvedConceptReferenceList resolveToList(org.LexGrid.LexBIG.DataModel.cagrid.SetResolutionPolicy policy)
                                                                                    throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                                                                           org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                                                           org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                                                           java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Resolve the set to a list of concepts sorted by the supplied parameters, resolving all of the properties named in the list.

Specified by:
resolveToList in interface CodedNodeSetGrid
Parameters:
policy - Policy for resolving the relationship
Returns:
A list of concept references, up to the maximum number specified. Note that in the event that a maximum number 'n' is specified and exactly 'n' items are resolved, there is currently no flag or notification provided to indicate the requested list is fully resolved.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToCodes

public CodedNodeSetGrid restrictToCodes(org.LexGrid.LexBIG.DataModel.Collections.ConceptReferenceList codeList)
                                 throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                        org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                        org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                        java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Restrict the set to the list of codes in the supplied conceptReference list

Specified by:
restrictToCodes in interface CodedNodeSetGrid
Parameters:
codeList - The list of codes to filter on.
Returns:
A new CodedNodeSet containing the filtered result.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToMatchingDesignations

public CodedNodeSetGrid restrictToMatchingDesignations(org.LexGrid.LexBIG.DataModel.cagrid.MatchCriteria matchText,
                                                       org.LexGrid.LexBIG.DataModel.enums.SearchDesignationOption option,
                                                       org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification matchAlgorithm,
                                                       org.LexGrid.LexBIG.DataModel.cagrid.LanguageIdentification language)
                                                throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                                       org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                       org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                       java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Restrict the list to the set of concepts that have designations that match the supplied string, using the supplied matching algorithm and language

Specified by:
restrictToMatchingDesignations in interface CodedNodeSetGrid
Parameters:
matchText - Filter String - syntax is determined by the match algorithm
option - 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.
Returns:
A new CodedNodeSet containing the filtered result.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToMatchingProperties

public CodedNodeSetGrid restrictToMatchingProperties(org.LexGrid.LexBIG.DataModel.Collections.LocalNameList propertyNames,
                                                     org.LexGrid.LexBIG.DataModel.enums.PropertyType[] propertyTypes,
                                                     org.LexGrid.LexBIG.DataModel.Collections.LocalNameList sourceList,
                                                     org.LexGrid.LexBIG.DataModel.Collections.LocalNameList contextList,
                                                     org.LexGrid.LexBIG.DataModel.Collections.NameAndValueList qualifierList,
                                                     org.LexGrid.LexBIG.DataModel.cagrid.MatchCriteria matchText,
                                                     org.LexGrid.LexBIG.DataModel.cagrid.ExtensionIdentification matchAlgorithm,
                                                     org.LexGrid.LexBIG.DataModel.cagrid.LanguageIdentification language)
                                              throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                                     org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                                     org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                                     java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Remove all elements from the set that do not have one or more properties that match the given criteria.

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.

Specified by:
restrictToMatchingProperties in interface CodedNodeSetGrid
Parameters:
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.
Returns:
A new CodedNodeSet containing the filtered result.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToProperties

public CodedNodeSetGrid restrictToProperties(org.LexGrid.LexBIG.DataModel.Collections.LocalNameList propertyList,
                                             org.LexGrid.LexBIG.DataModel.enums.PropertyType[] propertyTypes,
                                             org.LexGrid.LexBIG.DataModel.Collections.LocalNameList sourceList,
                                             org.LexGrid.LexBIG.DataModel.Collections.LocalNameList contextList,
                                             org.LexGrid.LexBIG.DataModel.Collections.NameAndValueList qualifierList)
                                      throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                             org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                             org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                             java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Remove all elements from the set that don't have one or more properties that match the given criteria.

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.

Specified by:
restrictToProperties in interface CodedNodeSetGrid
Parameters:
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.
Returns:
A new CodedNodeSet containing the filtered result.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

restrictToStatus

public CodedNodeSetGrid restrictToStatus(org.LexGrid.LexBIG.DataModel.enums.ActiveOption activeOption,
                                         org.LexGrid.LexBIG.DataModel.cagrid.Status[] status)
                                  throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                                         org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                                         org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                                         java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Restrict the set to concepts matching the given status criteria.

Specified by:
restrictToStatus in interface CodedNodeSetGrid
Parameters:
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.
status - 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.
Returns:
A new CodedNodeSet containing the filtered result.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

union

public CodedNodeSetGrid union(CodedNodeSetGrid codes)
                       throws org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException,
                              org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException,
                              org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess,
                              java.rmi.RemoteException
Description copied from interface: CodedNodeSetGrid
Return the set union of all of the codes in the containing or the referenced set

Specified by:
union in interface CodedNodeSetGrid
Parameters:
codes - Codes to add to the union
Returns:
A new CodedNodeSet containing the merged result.
Throws:
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBInvocationException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.LBParameterException
org.LexGrid.LexBIG.cagrid.LexEVSGridService.stubs.types.InvalidServiceContextAccess
java.rmi.RemoteException

getCodedNodeSetInterface

public org.LexGrid.LexBIG.LexBIGService.CodedNodeSet getCodedNodeSetInterface()
                                                                       throws java.lang.Exception
Throws:
java.lang.Exception

getEndpointReference

public org.apache.axis.message.addressing.EndpointReferenceType getEndpointReference()