public class LexEVSPickListDefinitionServicesImpl extends java.lang.Object implements LexEVSPickListDefinitionServices
Modifier and Type | Field and Description |
---|---|
protected MessageDirector |
md_ |
protected LoadStatus |
status_ |
Constructor and Description |
---|
LexEVSPickListDefinitionServicesImpl() |
Modifier and Type | Method and Description |
---|---|
static LexEVSPickListDefinitionServices |
defaultInstance()
Returns a default singleton instance of the service.
|
void |
exportPickListDefinition(java.lang.String pickListId,
java.lang.String xmlFolderLocation,
boolean overwrite,
boolean failOnAllErrors)
Exports the pick list definition in LexGrid XML format.
|
java.lang.String |
getDescription() |
LexBIGService |
getLexBIGService()
Return the associated LexBIGService instance; lazy initialized as
required.
|
LogEntry[] |
getLogEntries() |
java.lang.String |
getName() |
PickListDefinition |
getPickListDefinitionById(java.lang.String pickListId)
Returns pickList definition for supplied pickListId.
|
java.util.List<java.lang.String> |
getPickListDefinitionIdForValueSetDefinitionUri(java.net.URI valueSetDefURI)
Returns all the pickList definition id's that represents supplied value set definition URI.
|
java.util.List<java.lang.String> |
getPickListIdsForSupportedTagAndValue(java.lang.String supportedTag,
java.lang.String value)
Returns all the pickListIds that contain supplied supported tag and value.
|
java.net.URI |
getPickListValueSetDefinition(java.lang.String pickListId)
Returns an URI of the represented value set definition of the pickList.
|
java.lang.String |
getProvider() |
java.util.Map<java.lang.String,java.lang.String> |
getReferencedPLDefinitions(java.lang.String valueSet,
java.lang.Boolean extractPickListName)
Return the map set of pick list id and pick list name that references value set definition URI
|
java.util.Map<java.lang.String,java.lang.String> |
getReferencedPLDefinitions(java.lang.String entityCode,
java.lang.String entityCodeNameSpace,
java.lang.String propertyId,
java.lang.Boolean extractPickListName)
Return the map set of pick list id and pick list name that references given entityCode, namespace and optionally propertyId
|
java.lang.String |
getVersion() |
java.util.List<java.lang.String> |
listPickListIds()
Returns list of pickListIds that are available in the system.
|
void |
loadPickList(PickListDefinition pldef,
java.lang.String systemReleaseURI,
Mappings mappings)
Loads supplied PickListDefinition object
|
void |
loadPickList(java.lang.String xmlFileLocation,
boolean failOnAllErrors)
Loads pick list by reading XML file location supplied
|
void |
removePickList(java.lang.String pickListId)
Removes pick list definition from the system that matches supplied pickListId.
|
ResolvedPickListEntryList |
resolvePickList(PickListDefinition pickList,
boolean sortByText,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolves pick list definition object supplied against supplied coding scheme version list.
|
ResolvedPickListEntryList |
resolvePickList(java.lang.String pickListId,
boolean sortByText,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolves pickList definition for supplied pickListId.
|
ResolvedPickListEntryList |
resolvePickList(java.lang.String pickListId,
java.lang.Integer sortType,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolves pickList definition for supplied pickListId.
|
PickListDefinition |
resolvePickListByRevision(java.lang.String pickListId,
java.lang.String revisionId,
java.lang.Integer sortOrder) |
ResolvedPickListEntryList |
resolvePickListForTerm(java.lang.String pickListId,
java.lang.String term,
java.lang.String matchAlgorithm,
java.lang.String language,
java.lang.String[] context,
boolean sortByText,
AbsoluteCodingSchemeVersionReferenceList csVersionList,
java.lang.String versionTag)
Resolves pickList definition for supplied arguments.
|
static void |
setDefaultInstance(LexEVSPickListDefinitionServicesImpl defaultInstance)
Assigns the default singleton instance of the service.
|
void |
setLexBIGService(LexBIGService lbs)
Assign the associated LexBIGService instance.
|
void |
validate(java.net.URI uri,
int v1) |
protected MessageDirector md_
protected LoadStatus status_
public LexEVSPickListDefinitionServicesImpl()
public static LexEVSPickListDefinitionServices defaultInstance()
Note: This is the recommended method of acquiring the service, since it will allow the application to run without change in distributed LexBIG environments (in which case the default instance is actually a distributed service). However, use of the public constructor is supported to preserve backward compatibility.
public static void setDefaultInstance(LexEVSPickListDefinitionServicesImpl defaultInstance)
Note: While this method is public, it is generally not intended to be part of the externalized API. It is made public so that the runtime system has the ability to assign the default instance when running in distributed LexBIG environments, etc.
LexEVSPickListDefinitionServicesImpl
- the default instance.public void loadPickList(PickListDefinition pldef, java.lang.String systemReleaseURI, Mappings mappings) throws LBException
LexEVSPickListDefinitionServices
loadPickList
in interface LexEVSPickListDefinitionServices
pldef
- pick list to loadLBException
public void loadPickList(java.lang.String xmlFileLocation, boolean failOnAllErrors) throws LBException
LexEVSPickListDefinitionServices
loadPickList
in interface LexEVSPickListDefinitionServices
xmlFileLocation
- XML file containing pick list definitionsLBException
public void validate(java.net.URI uri, int v1) throws LBException
validate
in interface LexEVSPickListDefinitionServices
uri
- XML file containing pickList definitionsv1
- validate <int> Perform validation of the candidate
resource without loading data.
Supported levels of validation include:
0 = Verify document is well-formed
1 = Verify document is validLBException
public PickListDefinition getPickListDefinitionById(java.lang.String pickListId) throws LBException
LexEVSPickListDefinitionServices
getPickListDefinitionById
in interface LexEVSPickListDefinitionServices
pickListId
- pickListId of a pickListDefinitionLBException
public java.util.List<java.lang.String> listPickListIds() throws LBException
LexEVSPickListDefinitionServices
listPickListIds
in interface LexEVSPickListDefinitionServices
LBException
public java.net.URI getPickListValueSetDefinition(java.lang.String pickListId) throws LBException
LexEVSPickListDefinitionServices
getPickListValueSetDefinition
in interface LexEVSPickListDefinitionServices
LBException
public java.util.List<java.lang.String> getPickListDefinitionIdForValueSetDefinitionUri(java.net.URI valueSetDefURI) throws LBException
LexEVSPickListDefinitionServices
getPickListDefinitionIdForValueSetDefinitionUri
in interface LexEVSPickListDefinitionServices
valueSetDefURI
- URI of an value set definitionLBException
public ResolvedPickListEntryList resolvePickListForTerm(java.lang.String pickListId, java.lang.String term, java.lang.String matchAlgorithm, java.lang.String language, java.lang.String[] context, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
LexEVSPickListDefinitionServices
resolvePickListForTerm
in interface LexEVSPickListDefinitionServices
pickListId
- pickListId of a pickListDefinition. This is required argument.term
- Term to restrict. This is required argument.matchAlgorithm
- Optional, match algorithm to use.language
- Optional, language to restrict.context
- Optional, list of context to restrict.sortByText
- If True; the resolved pickListEntries will be sorted by text in ascending order.csVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.LBException
public ResolvedPickListEntryList resolvePickList(java.lang.String pickListId, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
LexEVSPickListDefinitionServices
resolvePickList
in interface LexEVSPickListDefinitionServices
pickListId
- pickListId of a pickListDefinition.sortByText
- If True; the resolved pickListEntries will be sorted by text in ascending order.csVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.LBException
public ResolvedPickListEntryList resolvePickList(java.lang.String pickListId, java.lang.Integer sortType, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
LexEVSPickListDefinitionServices
resolvePickList
in interface LexEVSPickListDefinitionServices
pickListId
- pickListId of a pickListDefinition.csVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.LBException
public ResolvedPickListEntryList resolvePickList(PickListDefinition pickList, boolean sortByText, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag) throws LBException
LexEVSPickListDefinitionServices
resolvePickList
in interface LexEVSPickListDefinitionServices
pickList
- pickListDefinition object.sortByText
- If True; the resolved pickListEntries will be sorted by text in ascending order.csVersionList
- - a list of coding scheme URI's and versions to be used. These will be used only if they are present in
the service. If absent, the most recent version will be used instead.versionTag
- - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present.
Note that non-tagged versions will be used if the tagged version is missing.LBException
public void removePickList(java.lang.String pickListId) throws LBException
LexEVSPickListDefinitionServices
removePickList
in interface LexEVSPickListDefinitionServices
pickListId
- id of pickList to removeLBException
public java.util.Map<java.lang.String,java.lang.String> getReferencedPLDefinitions(java.lang.String entityCode, java.lang.String entityCodeNameSpace, java.lang.String propertyId, java.lang.Boolean extractPickListName) throws LBException
LexEVSPickListDefinitionServices
getReferencedPLDefinitions
in interface LexEVSPickListDefinitionServices
entityCode
- referenced entityCodeentityCodeNameSpace
- referenced entityCodeNamespacepropertyId
- Optional propertyIdextractPickListName
- true means pick list name will be extracted in the map set.LBException
public java.util.Map<java.lang.String,java.lang.String> getReferencedPLDefinitions(java.lang.String valueSet, java.lang.Boolean extractPickListName) throws LBException
LexEVSPickListDefinitionServices
getReferencedPLDefinitions
in interface LexEVSPickListDefinitionServices
valueSet
- URI of value set definitionextractPickListName
- true means pick list name will be extracted in the map setLBException
public java.lang.String getDescription()
public java.lang.String getName()
public java.lang.String getProvider()
public java.lang.String getVersion()
public LogEntry[] getLogEntries()
getLogEntries
in interface LexEVSPickListDefinitionServices
public void setLexBIGService(LexBIGService lbs)
Note: This method must be invoked by users of the distributed LexBIG API to set the service to an EVSApplicationService object, allowing client side implementations to use these convenience methods.
public LexBIGService getLexBIGService()
public java.util.List<java.lang.String> getPickListIdsForSupportedTagAndValue(java.lang.String supportedTag, java.lang.String value)
LexEVSPickListDefinitionServices
getPickListIdsForSupportedTagAndValue
in interface LexEVSPickListDefinitionServices
supportedTag
- like SupportedCodingScheme, SupportedAssociation etc.value
- value to look forpublic void exportPickListDefinition(java.lang.String pickListId, java.lang.String xmlFolderLocation, boolean overwrite, boolean failOnAllErrors) throws LBException
LexEVSPickListDefinitionServices
exportPickListDefinition
in interface LexEVSPickListDefinitionServices
pickListId
- id of pick list definition to exportxmlFolderLocation
- destination locationLBException
public PickListDefinition resolvePickListByRevision(java.lang.String pickListId, java.lang.String revisionId, java.lang.Integer sortOrder) throws LBRevisionException
resolvePickListByRevision
in interface LexEVSPickListDefinitionServices
LBRevisionException