gov.nih.nci.dtsrpc.client
Class DTSRPCClient

java.lang.Object
  gov.nih.nci.dtsrpc.client.DTSRPCClient

public class DTSRPCClient

extends java.lang.Object

DTSRPC Client Class

Since:

DTSRPC 1.0

Version:

2.0

Author:

Northrop Grumman Mission Systems

Field Summary

static java.lang.String	CONCEPT_STATUS a static string "Concept_Status"
static java.lang.String	EDIT_ACTION_CREATE_STR Constant string for Create action
static java.lang.String	EDIT_ACTION_MERGE_STR Constant string for Merge action
static java.lang.String	EDIT_ACTION_MODIFY_STR Constant string for Modify action
static java.lang.String	EDIT_ACTION_RETIRE_STR Constant string for Retire action
static java.lang.String	EDIT_ACTION_SPLIT_STR Constant string for Split action
static java.lang.String	NAMESPACE_TYPE_CONNECTION Constant string for NAMESPACE_TYPE_CONNECTION
static java.lang.String	NAMESPACE_TYPE_ONTYLOG Constant string for NAMESPACE_TYPE_ONTYLOG
static java.lang.String	NAMESPACE_TYPE_THESAURUS Constant string for NAMESPACE_TYPE_THESAURUS
static java.util.Date	NO_HISTORY_DATE A constant date (January 1, 1970)
static int	PING_DTS_COMMUNICATION_DOWN Ping server failure mode 3 -- DTS communication is down.
static int	PING_DTS_DATABASE_DOWN Ping server failure mode 2 -- DTS database server is down.
static int	PING_DTS_SERVER_DOWN Ping server failure mode 1 -- DTS server is down.
static int	PING_RPC_FAILURE Ping server failure mode 4 -- XML-RPC exception.
static int	PING_SUCCESS A constant, 0, indicating that no failure mode is encountered.
boolean	useTitleCase a boolean variable true, if apply title case conversion; false, otherwise

Constructor Summary

DTSRPCClient()
a constructor for creating an instance of DTSRPCClient.

DTSRPCClient(java.lang.String ip, java.lang.String port)
a constructor for creating an instance of DTSRPCClient.

Method Summary

java.lang.Boolean	containsInverseRole(java.lang.String role_name, java.lang.String role_value, java.lang.String ontylogconcept_in) Checks if a ontylog concept in a namespace has a specific inverse role and if so whether the role has a specific value
java.lang.Boolean	containsInverseRole(java.lang.String role_name, java.lang.String role_value, java.lang.String ontylogconcept_in, int namespaceId) Checks if a ontylog concept in a namespace has a specific inverse role and if so whether the role has a specific value
java.lang.Boolean	containsRole(java.lang.String role_name, java.lang.String role_value, java.lang.String ontylogconcept_in) Checks if a ontylog concept in a namespace has a specific role and if so whether the role has a specific value
java.lang.Boolean	containsRole(java.lang.String role_name, java.lang.String role_value, java.lang.String ontylogconcept_in, int namespaceId) Checks if a ontylog concept in a namespace has a specific role and if so whether the role has a specific value
java.util.Vector	fetchDTSProperties(java.lang.String term_in) Fetchs the properties of a givn concept belonging to a given namespace
java.util.Vector	fetchDTSProperties(java.lang.String term_in, int namespaceId) Fetchs the properties of a givn concept belonging to a given namespace
java.util.Vector	fetchTermAssociations(java.lang.String term_in) Fetchs term association data corresponding to a concept belonging to a given namespace .
java.util.Vector	fetchTermAssociations(java.lang.String term_in, int namespaceId) Fetchs term association data corresponding to a concept belonging to a given namespace .
Concept	findConcept(java.lang.String conceptname) Retrieves the Concept corresponding to a specific Concept name in the default namespace with all fetched attributes
Concept	findConcept(java.lang.String conceptname, boolean allAttributes) Retrieves the Concept corresponding to a specific Concept name in the default namespace with all fetched attributes
Concept	findConcept(java.lang.String conceptname, int namespaceId) Retrieves the Concept corresponding to a specific Concept name in a specific namespace with all fetched attributes
Concept	findConcept(java.lang.String conceptname, int ASD_index, int namespaceId) Retrieves the Concept corresponding to a specific Concept name in a specific namespace
Concept	findConceptByCode(java.lang.String conceptcode) Retrieves the Concept corresponding to a specific Concept code in the default namespace with all attributes retrieved
Concept	findConceptByCode(java.lang.String conceptcode, boolean allAttributes) Retrieves the Concept corresponding to a specific Concept code in the default namespace
Concept	findConceptByCode(java.lang.String conceptcode, int namespaceId) Retrieves the Concept corresponding to a specific Concept name in a specific namespace
Concept	findConceptByCode(java.lang.String conceptcode, int ASD_index, int namespaceId) Retrieves the Concept corresponding to a specific Concept name in a specific namespace
java.util.Vector	findConceptsByCode(java.util.Vector conceptCodes_in) Finds concept names matched with specified concept codes.
java.util.Vector	findConceptsByCode(java.util.Vector conceptCodes_in, java.util.Vector namespaceIds_in) Finds concept names matched with specified concept codes.
java.util.Vector	findConceptsById(java.util.Vector conceptIds_in) Finds concept names matched with specified concept ids.
java.util.Vector	findConceptsById(java.util.Vector conceptIds_in, java.util.Vector namespaceIds_in) Finds concept names matched with specified concept ids.
java.util.Vector	findConceptsWithConceptAssociationMatching(java.lang.String conceptAssocType_in, java.lang.String toConceptName, int searchLimit) Finds concepts with a concept association matching a specific search criteria.
java.util.Vector	findConceptsWithConceptAssociationMatching(java.lang.String conceptAssocType_in, java.lang.String toConceptName, int searchLimit, int namespaceId) Finds concepts with a concept association matching a specific search criteria.
java.util.Vector	findConceptsWithInverseConceptAssociationMatching(java.lang.String invConceptAssocType_in, java.lang.String fromConceptName, int searchLimit) Finds concepts with an inverse concept association matching a specific search criteria.
java.util.Vector	findConceptsWithInverseConceptAssociationMatching(java.lang.String invConceptAssocType_in, java.lang.String fromConceptName, int searchLimit, int namespaceId) Finds concepts with an inverse concept association matching a specific search criteria.
java.util.Vector	findConceptsWithInverseRoleMatching(java.lang.String roleType_in, java.lang.String pattern, int searchLimit) Finds concepts with an inverse role matching a specific search criteria.
java.util.Vector	findConceptsWithInverseRoleMatching(java.lang.String roleType_in, java.lang.String pattern, int searchLimit, int namespaceId) Finds concepts with an inverse role matching a specific search criteria.
java.util.Vector	findConceptsWithNameMatching(java.lang.String pattern, int searchLimit) Finds concepts with name matching a specific search criteria.
java.util.Vector	findConceptsWithNameMatching(java.lang.String pattern, int searchLimit, boolean synonyms) Finds concepts with name matching a specific search criteria.
java.util.Vector	findConceptsWithNameMatching(java.lang.String pattern, int searchLimit, boolean synonyms, int namespaceId) Finds concepts with name matching a specific search criteria.
java.util.Vector	findConceptsWithNameMatching(java.lang.String pattern, int searchLimit, int namespaceId) Finds concepts with name matching a specific search criteria.
java.util.Vector	findConceptsWithPropertyContaining(java.lang.String propType_in, java.lang.String pattern, int searchLimit) Finds concepts with a property containing a specific search criteria.
java.util.Vector	findConceptsWithPropertyContaining(java.lang.String propType_in, java.lang.String pattern, int searchLimit, int namespaceId) Finds concepts with a property containing a specific search criteria.
java.util.Vector	findConceptsWithPropertyMatching(java.lang.String propType_in, java.lang.String pattern, int searchLimit) Finds concepts with a property matching a specific search criteria.
java.util.Vector	findConceptsWithPropertyMatching(java.lang.String propType_in, java.lang.String pattern, int searchLimit, int namespaceId) Finds concepts with a property matching a specific search criteria.
java.util.Vector	findConceptsWithRoleMatching(java.lang.String roleType_in, java.lang.String pattern, int searchLimit) Finds concepts with a role matching a specific search criteria.
java.util.Vector	findConceptsWithRoleMatching(java.lang.String roleType_in, java.lang.String pattern, int searchLimit, int namespaceId) Finds concepts with a role matching a specific search criteria.
java.util.Vector	findConceptsWithRoleOrPropertyMatching(int namespaceId, java.lang.String infixExpression) Finds concepts with roles or properties matching with a specific search criteria.
java.util.Vector	findConceptsWithRoleOrPropertyMatching(java.lang.String infixExpression) Performs complex search for concepts that match a search criteria defined by roles, properties, and binary operators, AND, OR, and NOT.
java.util.Vector	findConceptsWithSiloMatching(java.lang.String pattern, int limit) Gets a vector of silo names that represent the search pattern, but with those attributes present that are specified in the AttributteSetDescriptor.
Concept[]	findConceptsWithSiloMatching(java.lang.String pattern, int limit, int ASD_index, boolean bestMatchOnly, boolean spellCorrection, boolean closeResult, int matchtype_index, java.lang.String siloname) Gets an array of Concept objects that represents the search pattern since DTSRPC 2.1
java.util.Vector	findConceptsWithSiloMatching(java.lang.String pattern, int limit, java.lang.String siloname) Gets a vector of silo names that represent the search pattern, but with those attributes present that are specified in the AttributteSetDescriptor.
java.util.Vector	findConceptsWithSynonymMatching(java.lang.String synonymType_in, java.lang.String synonymTermName, int searchLimit) Finds concepts with a synonym matching a specific search criteria.
java.util.Vector	findConceptsWithSynonymMatching(java.lang.String synonymType_in, java.lang.String synonymTermName, int searchLimit, int namespaceId) Finds concepts with a synonym matching a specific search criteria.
java.util.Vector	findConceptWithPropertyMatching(java.lang.String propertyname, java.lang.String pattern, int matchLimit) Gets all concepts that have a property value of the given property that matches the argument pattern.
java.util.Vector	findConceptWithRoleMatching(java.lang.String rolename, java.lang.String pattern, int matchLimit) Gets all concepts that have a role value of the given role that matches the argument pattern.
java.lang.String	findNamespaceByCode(java.lang.String namespaceCode) Finds the namespace that matched with a specified id
java.lang.String	findNamespaceById(int namespaceId) Finds the namespace that matched with a specified id
java.util.Vector	findTermsByName(java.lang.String termname_in) Finds terms that match with a specific search string
java.util.Vector	findTermsByName(java.lang.String termname_in, int namespaceId) Finds terms that match with a specific search string
java.util.Vector	findTermsWithNameMatching(java.lang.String pattern, int searchLimit) Retrieves each term with a name (string identifier) that matches the argument pattern, based on the specified search options.
java.util.Vector	findTermsWithNameMatching(java.lang.String pattern, int searchLimit, int namespaceId) Retrieves each term with a name (string identifier) that matches the argument pattern, based on the specified search options.
java.util.Vector	getAllAssociationTypes() Retrieves all association types known in the knowledgebase.
java.util.Vector	getAllConceptAssociationQualifierTypes() Retrieves the names of all concept association qualifier types.
java.util.Vector	getAllConceptAssociationTypes() Retrieves all concept association types.
java.util.Vector	getAllConceptPropertyQualifierTypes() Retrieves all concept property qualifier type names.
java.util.Vector	getAllConceptPropertyTypes() Retrieves all concept property types.
java.util.Vector	getAllLicenses(java.lang.String condition) Gets all licenses from the server.
PropertyType[]	getAllPropertyTypes() Retrieves all PropertyType
PropertyType[]	getAllPropertyTypes(int namespaceId) Retrieves all PropertyType in a given namespace
java.util.Vector	getAllQualifierTypes() Retrieves all qualifier type names.
java.util.Vector	getAllRoleNames() Gets all role names defined in the default namespace
java.util.Vector	getAllRoleNames(int namespaceId) Gets the role names defined in a particular namespace.
RoleType[]	getAllRoleTypes() Retrieves all RoleType
RoleType[]	getAllRoleTypes(int namespaceId) Retrieves all RoleType in a given namespace
RoleType[]	getAllRoleTypesInNamespace() Retrieves all RoleType in the default namespace
Silo[]	getAllSilos() Retrieves all silos
java.util.Vector	getAllSubConceptCodes(java.lang.String conceptCode) Gets the codes of all subconcept of a specified concept
java.util.Vector	getAllSubConceptCodes(java.lang.String conceptCode, int namespaceId) Gets the codes of all subconcept of a specified concept
java.util.Vector	getAllSubConceptNames(java.lang.String conceptName) Gets the names of all subconcept of a specified concept
java.util.Vector	getAllSubConceptNames(java.lang.String conceptName, int namespaceId) Gets the names of all subconcept of a specified concept
java.util.Vector	getAllSynonymTypes() Retrieves all synonym types.
java.util.Vector	getAllTermAssociationQualifierTypes() Retrieves all term association qualifier type names.
java.util.Vector	getAllTermAssociationTypes() Retrieves all term association types.
java.util.Vector	getAllTermPropertyQualifierTypes() Retrieves all term property qualifier type names.
java.util.Vector	getAllTermPropertyTypes() Retrieves all term property types.
java.util.Vector	getAncestorCodeActionDates(int namespaceId, java.lang.String inCode, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the ancestor concepts' CodeActionDate of the specified concept.
java.util.Vector	getAncestorCodeActionDates(java.lang.String inCode, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the ancestor concepts' CodeActionDate of the specified concept.
java.util.Vector	getAncestorCodes(int namespaceId, java.lang.String inCode, boolean atBaseline, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the ancestor concept codes of the specified concept.
java.util.Vector	getAncestorCodes(java.lang.String inCode, boolean atBaseline, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the ancestor concept codes of the specified concept.
java.util.Vector	getAuthorities() Retrieves a vector of Authority names which represent the available namespace authorities in the DTS knowledgebase.
java.util.Vector	getCodeActionChildren(int namespaceId, java.lang.String inCode, java.util.Date baselineDate_in) Gets the descendant concepts' codes of the specified concept involved in "split or merge" actions that occurred in the specified baseline date.
java.util.Vector	getCodeActionChildren(java.lang.String inCode, java.util.Date baselineDate_in) Gets the descendant concepts' codes of the specified concept involved in "split or merge" actions that occurred in the specified baseline date.
java.util.Vector	getCodeActionParents(int namespaceId, java.lang.String inCode, java.util.Date baselineDate_in) Gets the ancestor concepts' codes of the specified concept involved in "split or merge" actions that occurred in the specified baseline date.
java.util.Vector	getCodeActionParents(java.lang.String inCode, java.util.Date baselineDate_in) Gets the ancestor concepts' codes of the specified concept involved in "split or merge" actions that occurred in the specified baseline date.
java.util.Vector	getComplexPropertyElements(java.lang.String propValue) Gets tag names in a XML formatted sString
java.lang.String	getComplexPropertyElementValue(java.lang.String element, java.lang.String propValue) Gets the value associated with the element in the property value
Concept	getConcept(java.lang.String inputvalue, boolean inputcode, int ASD_index) Retrieves the Concept corresponding to a specific Concept name, or code in the default namespace with all fetched attributes
Concept	getConcept(java.lang.String inputvalue, boolean inputcode, int ASD_index, int namespaceId) Retrieves the Concept corresponding to a specific Concept name, or code in the default namespace with all fetched attributes
java.util.Vector	getConceptAssociationQualifierTypes() Retrieves the names of all concept association qualifier types
java.util.Vector	getConceptAssociationQualifierTypes(int namespaceId) Retrieves the names of all concept association qualifier types within a given namespace.
java.util.Vector	getConceptAssociationTypes() Retrieves all concept association types.
java.util.Vector	getConceptAssociationTypes(int namespaceId) Retrieves all concept association types in a namespace.
java.util.Vector	getConceptChildRoots() Gets the names of root concepts
java.util.Vector	getConceptChildRoots(int namespaceId) Get root concept names
java.lang.String	getConceptCodeByName(java.lang.String conceptname) Finds the code of the specified concept.
java.lang.String	getConceptCodeByName(java.lang.String conceptname, int namespaceId) Finds the code of the specified concept.
java.util.Date	getConceptCreationDate(int namespaceId, java.lang.String inCode) Gets the baseline date of creation of the specified concept.
java.util.Date	getConceptCreationDate(java.lang.String inCode) Gets the baseline date of creation of the specified concept.
java.util.Vector	getConceptEditAction(int namespaceId, java.lang.String inCode) Gets all EditAction of the specified concept.
java.util.Vector	getConceptEditAction(int namespaceId, java.lang.String inCode, java.util.Date baselineDate_in) Gets all EditAction of the specified concept.
java.util.Vector	getConceptEditAction(java.lang.String inCode) Gets all EditAction of the specified concept.
java.util.Vector	getConceptEditAction(java.lang.String inCode, java.util.Date baselineDate_in) Gets all EditAction of the specified concept.
java.util.Vector	getConceptEditActionDates(int namespaceId, java.lang.String inCode, int iAction) Gets EditActionDate that match with the given concept code and edit action index.
java.util.Vector	getConceptEditActionDates(java.lang.String inCode, int iAction) Gets EditActionDate that match with the given concept code and edit action index.
java.util.Vector	getConceptEditActionDates(java.lang.String inCode, java.lang.String action) Gets EditActionDate that match with the given concept code and edit action index.
ConceptHistory	getConceptHistory(int namespaceId, java.lang.String conceptcode) Retrieves the ConceptHistory corresponding to a specific concept in a given namespace
ConceptHistory	getConceptHistory(java.lang.String conceptcode) Retrieves the ConceptHistory corresponding to a specific concept.
java.lang.String	getConceptNameByCode(java.lang.String conceptcode) Finds the code of the specified concept.
java.lang.String	getConceptNameByCode(java.lang.String conceptcode, int namespaceId) Finds the code of the specified concept.
java.util.Vector	getConceptPropertyQualifierTypes() Retrieves all concept property qualifier types.
java.util.Vector	getConceptPropertyQualifierTypes(int namespaceId) Retrieves all concept property qualifier types within a given namespace.
java.util.Vector	getConceptPropertyTypes() Retrieves all concept property types.
java.util.Vector	getConceptPropertyTypes(int namespaceId) Retrieves all concept property types within a given namespace.
Concept[]	getConcepts(java.util.Vector conceptNames_in) Retrieves Concepts with name matching with specified values
Concept[]	getConcepts(java.util.Vector conceptNames_in, boolean allAttributes) Retrieves Concepts with name matching with specified values
Concept[]	getConcepts(java.util.Vector conceptNames_in, int ASD_index, java.util.Vector namespaceIds_in) Retrieves Concepts with name matching with specified values
java.util.Vector	getConceptStatus(java.lang.String conceptname) Gets the status of the specific concept
java.util.Vector	getConceptStatus(java.lang.String conceptname, int namespaceId) Gets the status of the specific concept
java.util.Date	getCreationDate(java.lang.String inCode) Gets the creation date of a concept
java.util.Vector	getDescendantCodeActionDates(int namespaceId, java.lang.String inCode, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the descendant concepts' CodeActionDate of the specified concept.
java.util.Vector	getDescendantCodeActionDates(java.lang.String inCode, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the descendant concepts' CodeActionDate of the specified concept.
java.util.Vector	getDescendantCodes(int namespaceId, java.lang.String inCode, boolean atBaseline, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the descendant concept codes of the specified concept.
java.util.Vector	getDescendantCodes(java.lang.String inCode, boolean atBaseline, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the descendant concept codes of the specified concept.
Concept[]	getDirectSubs(java.lang.String conceptname) Retrieves direct superconcepts of a specific Concept in a specific namespace
Concept[]	getDirectSubs(java.lang.String conceptname, boolean allAttributes) Retrieves direct superconcepts of a specific Concept in a specific namespace
Concept[]	getDirectSubs(java.lang.String inputvalue, boolean inputcode, int ASD_index, int namespaceId) Retrieves direct superconcepts of a specific Concept in a specific namespace
Concept[]	getDirectSubs(java.lang.String conceptname, int namespaceId) Retrieves direct superconcepts of a specific Concept in a specific namespace
Concept[]	getDirectSubs(java.lang.String conceptname, int ASD_index, int namespaceId) Retrieves direct superconcepts of a specific Concept in a specific namespace
Concept[]	getDirectSups(java.lang.String conceptname) Retrieves direct superconcepts of a specific Concept in the default namespace.
Concept[]	getDirectSups(java.lang.String conceptname, boolean allAttributes) Retrieves direct superconcepts of a specific Concept in the default namespace.
Concept[]	getDirectSups(java.lang.String inputvalue, boolean inputcode, int ASD_index, int namespaceId) Retrieves the direct superconcepts of a specific concept in a given namespace
Concept[]	getDirectSups(java.lang.String conceptname, int namespaceId) Retrieves direct superconcepts of a specific Concept in a specific namespace.
Concept[]	getDirectSups(java.lang.String conceptname, int ASD_index, int namespaceId) Retrieves the direct superconcepts of a specific concept in a given namespace
java.lang.Boolean	getFetchedHasSubs(java.lang.String ontylogconcept_in) Checks if the concept has subconcepts.
java.lang.Boolean	getFetchedHasSubs(java.lang.String ontylogconcept_in, int namespaceId) Checks if the concept has subconcepts.
java.lang.Boolean	getFetchedHasSups(java.lang.String ontylogconcept_in) Checks if the concept has superconcepts.
java.lang.Boolean	getFetchedHasSups(java.lang.String ontylogconcept_in, int namespaceId) Checks if the concept has superconcepts.
java.util.Vector	getFetchedInverseRoles(java.lang.String ontylogconcept_in) Gets the fetched inverse roles of a given concept.
java.util.Vector	getFetchedInverseRoles(java.lang.String ontylogconcept_in, int namespaceId) Gets the fetched inverse roles of a given concept.
java.util.Vector	getFetchedInverseTermAssociations(java.lang.String term_in) Gets the inverse term associations which have been fetched for this term.
java.util.Vector	getFetchedInverseTermAssociations(java.lang.String term_in, int namespaceId) Gets the inverse term associations which have been fetched for this term.
java.util.Vector	getFetchedRoles(java.lang.String ontylogconcept_in) Gets the roles which have been retrieved for this concept.
java.util.Vector	getFetchedRoles(java.lang.String ontylogconcept_in, int namespaceId) Gets the roles which have been retrieved for this concept.
java.util.Vector	getFetchedTermAssociations(java.lang.String term_in) Gets the term associations which have been fetched for this term.
java.util.Vector	getFetchedTermAssociations(java.lang.String term_in, int namespaceId) Gets the term associations which have been fetched for this term.
java.util.Vector	getHistoryDates() Gets all distinct dates in concept_history table.
java.util.Date	getHistoryEnd() Gets the latest date in concept_history table.
java.util.Date	getHistoryEndDate() Gets history end date
java.util.Vector	getHistoryRecords(java.lang.String vocabularyName, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Retrieves a set of history records from the concept_history table.
java.util.Vector	getHistoryRecords(java.lang.String vocabularyName, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in, java.lang.String conceptcode) Retrieves a set of history records from the concept_history table.
java.util.Vector	getHistoryRecords(java.lang.String vocabularyName, java.lang.String conceptcode) Retrieves a set of history records from the concept_history table.
java.util.Date	getHistoryStart() Gets the initial date in concept_history table.
java.util.Date	getHistoryStartDate() Gets history starting date
java.util.Vector	getKindNames() Gets kind names .
java.lang.String	getLicense(java.lang.String source) Gets the license for a given source.
java.lang.Integer	getMatchedTermCount(java.lang.String pattern) Gets the total number of matched terms.
java.lang.Integer	getMatchedTermCount(java.lang.String pattern, java.util.Vector namespace_vec, java.util.Vector kind_vec) Gets the total number of matched terms.
java.util.Vector	getMatchedTerms(java.lang.String pattern, int searchLimit) Finds terms that match with a specific pattern.
java.util.Vector	getMatchedTerms(java.lang.String pattern, int initial_index, int final_index) Finds terms that match with a specific pattern.
java.util.Vector	getMatchedTerms(java.lang.String pattern, int initial_index, int final_index, java.util.Vector namespace_vec, java.util.Vector kind_vec) Finds terms that match with a specific pattern.
java.util.Vector	getMatchedTerms(java.lang.String pattern, int searchLimit, java.util.Vector namespace_vec, java.util.Vector kind_vec) Finds terms that match with a specific pattern.
java.util.Vector	getMatches(java.lang.String pattern, int matchLimit) Searches for concept names that partially match with the search pattern.
java.lang.String	getMatchItemType(java.lang.String term_in) Gets the match item type, i.e.
java.lang.String	getMatchItemType(java.lang.String term_in, int namespaceId) Gets the match item type, i.e.
java.lang.String	getMatchString(java.lang.String term_in) Gets the string that was matched.
java.lang.String	getMatchString(java.lang.String term_in, int namespaceId) Gets the string that was matched.
java.lang.String	getNamespaceDescription(java.lang.String namespaceName) Gets the description of a specific namespace
int	getNamespaceId(java.lang.String namespaceName) Gets the relative id of a namespace
java.util.Vector	getNamespaceNames() Gets namespace names
java.util.Vector	getNamespaces() Gets available namespaces in a knowledgebase Note: in DTS 3.0, each connection is associated with a knowledgebase Each knowledgebase can contain multiple namespaces
java.lang.String	getNamespaceType(java.lang.String namespaceName) Gets namespace type .
int	getNumberEditActions(int namespaceId, java.lang.String inCode, java.util.Date baselineDate_in) Gets the number of editing actions on the specified concept registered in the specified baseline date.
int	getNumberEditActions(int namespaceId, java.lang.String inCode, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the number of editing actions on the specified concept registered in the specified baseline date.
int	getNumberEditActions(java.lang.String inCode, java.util.Date baselineDate_in) Gets the number of editing actions on the specified concept registered in the specified baseline date.
int	getNumberEditActions(java.lang.String inCode, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Gets the number of editing actions on the specified concept registered in the specified baseline date.
int	getNumberOfSpecifiedInverseRoles(java.lang.String ontylogconcept_in) Get the number of inverse roles that are available of the types specified in the ConceptAttributeSetDescriptor used to obtain this OntylogConcept.
int	getNumberOfSpecifiedInverseRoles(java.lang.String ontylogconcept_in, int namespaceId) Gets the number of inverse roles that are available of the types specified in the ConceptAttributeSetDescriptor used to obtain this OntylogConcept.
int	getNumberOfSpecifiedInverseTermAssociations(java.lang.String term_in) Gets the number of inverse term associations that are available for this term.
int	getNumberOfSpecifiedInverseTermAssociations(java.lang.String term_in, int namespaceId) Get the number of inverse term associations that are available for this term.
int	getNumberOfSpecifiedRoles(java.lang.String ontylogconcept_in) Gets the number of roles that are available of the types specified in the ConceptAttributeSetDescriptor used to obtain this OntylogConcept.
int	getNumberOfSpecifiedRoles(java.lang.String ontylogconcept_in, int namespaceId) Gets the number of roles that are available of the types specified in the ConceptAttributeSetDescriptor used to obtain this OntylogConcept.
int	getNumberOfSpecifiedTermAssociations(java.lang.String term_in) Gets the number of term associations that are available for the specified term.
int	getNumberOfSpecifiedTermAssociations(java.lang.String term_in, int namespaceId) Gets the number of term associations that are available for the specified term.
java.util.Vector	getPropertiesByConceptName(java.lang.String conceptname) Gets the names and values of properties owned by the specified concept.
java.util.Vector	getPropertiesByConceptName(java.lang.String conceptname, int namespaceId) Gets the names and values of properties owned by the specified concept.
java.util.Vector	getPropertyNames(java.lang.String conceptname) Gets the names of all roles owned by the specified concept (in the default namespace).
java.util.Vector	getPropertyNames(java.lang.String conceptname, int namespaceId) Gets the names of all properties owned by the specified concept.
PropertyType	getPropertyTypeById(int propertyId) Retrieves the PropertyType corresponding to a specific PropertyType identifier in the default namespace
PropertyType	getPropertyTypeById(int propertyId, int namespaceId) Retrieves the PropertyType corresponding to a specific PropertyType identifier in a specific namespace
PropertyType	getPropertyTypeByName(java.lang.String propertyName) Retrieves the PropertyType corresponding to a specific PropertyType name in the default namespace
PropertyType	getPropertyTypeByName(java.lang.String propertyName, int namespaceId) Retrieves the PropertyType corresponding to a specific PropertyType name in a given namespace
java.util.Vector	getPropertyTypes() Gets the names of all property types
java.util.Vector	getPropertyValues(java.lang.String conceptname, java.lang.String propertyname) Gets the values of a propertyies owned by a concept in the default name space
java.util.Vector	getPropertyValues(java.lang.String conceptname, java.lang.String propertyname, int namespaceId) Gets the values of a particular properties owned by the specified concept in a given namespace.
java.util.Vector	getRoleNames(java.lang.String conceptname) Gets the names of roles owned by a specific concept (in the default namespace)
java.util.Vector	getRoleNames(java.lang.String conceptname, int namespaceId) Gets the names of all roles owned by the specified concept.
java.util.Vector	getRolesByConceptName(java.lang.String conceptname) Gets the names and values of roles owned by the specified concept in the default namespace..
java.util.Vector	getRolesByConceptName(java.lang.String conceptname, int namespaceId) Gets the names and values of roles owned by the specified concept.
RoleType	getRoleTypeById(int roleId) Retrieves the RoleType corresponding to a specific RoleType identifier
RoleType	getRoleTypeById(int roleId, int namespaceId) Retrieves the RoleType corresponding to a specific RoleType identifier in a given namespace
RoleType	getRoleTypeByName(java.lang.String roleName) Retrieves the RoleType corresponding to a specific RoleType name in the default namespace
RoleType	getRoleTypeByName(java.lang.String roleName, int namespaceId) Retrieves the RoleType corresponding to a specific RoleType name in a given namespace
java.util.Vector	getRoleValues(java.lang.String conceptname, java.lang.String rolename) Gets the values of a role owned by a particular concept
java.util.Vector	getRoleValues(java.lang.String conceptname, java.lang.String rolename, int namespaceId) Gets the values of a particular role owned by the specified concept.
Concept[]	getRootConcepts() Retrieves all root concepts of in the default namespace.
Concept[]	getRootConcepts(boolean allAttributes) Retrieves all root concepts of in a given namespace.
Concept[]	getRootConcepts(int namespaceId) Retrieves all root concepts of in a given namespace.
Concept[]	getRootConcepts(int ASD_index, int namespaceId) Retrieves all root concepts of in a given namespace.
java.util.Vector	getSubConcepts(java.lang.String inputvalue, boolean inputcode, boolean outputcode) Gets the codes, or the names, of all subconcepts of the specified concept
java.util.Vector	getSubConcepts(java.lang.String inputvalue, java.lang.Boolean inputcodeObj, java.lang.Boolean outputcodeObj) Gets the codes, or the names, of all subconcepts of the specified concept
java.util.Vector	getSubConcepts(java.lang.String inputvalue, boolean inputcode, boolean outputcode, int namespaceId) Gets the codes, or the names, of all subconcepts of the specified concept
java.util.Vector	getSubConcepts(java.lang.String inputvalue, java.lang.Boolean inputcodeObj, java.lang.Boolean outputcodeObj, int namespaceId) Gets the names (or the codes) of a given concept in a specific namespace
java.util.Vector	getSuperConcepts(java.lang.String inputvalue, boolean inputcode, boolean outputcode) Gets the codes (or the names) of all superconcepts of the specified concepts.
java.util.Vector	getSuperConcepts(java.lang.String inputvalue, java.lang.Boolean inputcodeObj, java.lang.Boolean outputcodeObj) Gets the codes (or the names) of all superconcepts of the specified concepts.
java.util.Vector	getSuperConcepts(java.lang.String inputvalue, boolean inputcode, boolean outputcode, int namespaceId) Gets the codes (or the names) of all superconcepts of the specified concepts.
java.util.Vector	getSynonymTypes() Retrieves all synonym types.
java.util.Vector	getSynonymTypes(int namespaceId) Retrieves all synonym types in a given namespace.
java.util.Vector	getTermAssociationQualifierTypes() Retrieves all term association qualifier type names.
java.util.Vector	getTermAssociationQualifierTypes(int namespaceId) Retrieves all term association qualifier type names within a specific namespace.
java.util.Vector	getTermAssociationTypes() Retrieves all term association types.
java.util.Vector	getTermAssociationTypes(int namespaceId) Retrieves all term association types in a given namespace.
java.util.Vector	getTermPropertyQualifierTypes() Retrieves the names of all term property qualifier types
java.util.Vector	getTermPropertyQualifierTypes(int namespaceId) Retrieves the names of all term property qualifier types within a given namespace.
java.util.Vector	getTermPropertyTypes() Retrieves all term property types within a given namespace.
java.util.Vector	getTermPropertyTypes(int namespaceId) Retrieves all term property types within a given namespace.
javax.swing.tree.DefaultMutableTreeNode	getTree(java.lang.String rootname, boolean direction, AttributeSetDescriptor attributes) Gets tree data from the server (UserObject is a Concept instance).
javax.swing.tree.DefaultMutableTreeNode	getTree(java.lang.String rootname, boolean direction, int level, AttributeSetDescriptor attributes) Gets tree data from the server (UserObject is a Concept instance).
javax.swing.tree.DefaultMutableTreeNode	getTree(java.lang.String rootname, boolean direction, int level, AttributeSetDescriptor attributes, boolean isaflag, java.util.Vector rolenames) Gets tree data from the server (UserObject is a Concept instance).
javax.swing.tree.DefaultMutableTreeNode	getTree(java.lang.String rootname, boolean direction, int levels, AttributeSetDescriptor attributes, boolean isaflag, java.util.Vector rolenames, int namespaceId) Gets tree data.
javax.swing.tree.DefaultMutableTreeNode	getTree(java.lang.String rootname, boolean direction, int level, AttributeSetDescriptor attributes, int namespaceId) Gets tree data from the server (UserObject is a Concept instance).
javax.swing.tree.DefaultMutableTreeNode	getTree(java.lang.String rootname, boolean direction, int levels, java.lang.String propertyname) Gets tree data from the server (UserObject is a Concept instance).
javax.swing.tree.DefaultMutableTreeNode	getTree(java.lang.String rootname, boolean direction, int levels, java.lang.String propertyname, int namespaceId) Gets tree data from the server (UserObject is a Concept instance).
java.util.Vector	getVersions() Retrieves an array of ContentVersions which are the list of versions
java.util.Vector	getVersions(int namespaceId) Retrieves an array of ContentVersions which are the list of versions for the given namespace Id in the knowledgebase.
java.lang.String	getVocabularyDescription(java.lang.String name) Gets the description of a vocabulary
java.lang.String	getVocabularyHost(java.lang.String name) Gets the host of a vocabulary server
java.util.Vector	getVocabularyNames() Gets available vocabulary names
java.lang.String	getVocabularyPort(java.lang.String name) Gets the port of a vocabulary server
java.lang.String	getVocabularyVersion(java.lang.String name) Gets vocabulary name (a vocabulary name maps to a tuple)
java.lang.Boolean	hasChildren(java.lang.String conceptname) Checks if a concept in the default namespace has any subconcept
java.lang.Boolean	hasChildren(java.lang.String conceptname, int namespaceId) Checks if a concept in a namespace has any subconcepts.
java.lang.Boolean	hasParents(java.lang.String conceptname) Checks if a concept has any superconcept
java.lang.Boolean	hasParents(java.lang.String conceptname, int namespaceId) Checks if a concept has any superconcept .
java.lang.Boolean	hasPermission() Determine whether the currently logged on user has permission to write to the default namespace.
java.lang.Boolean	hasPermission(int namespaceId) Determine whether the currently logged on user has permission to write to the specified namespace.
java.lang.Boolean	hasStatus(java.lang.String conceptname) a boolean variable indicating whether the concept has a concept status
java.lang.Boolean	hasStatus(java.lang.String conceptname, int namespaceId) Checks if a concept has any status.
boolean	hasSubconcepts(java.lang.String conceptname) Checks if a concept in the default namespace has any subconcept
boolean	hasSubconcepts(java.lang.String conceptname, int namespaceId) Deprecated. replaced by hasChildren(java.lang.String) since DTSRPC 1.3.1
boolean	hasSuperconcepts(java.lang.String conceptname) Checks if a concept has any superconcept
boolean	hasSuperconcepts(java.lang.String conceptname, int namespaceId) Deprecated. replaced by hasParents(java.lang.String) since DTSRPC 1.3.1
java.lang.String	isCacheDone() Gets tree caching status.
java.lang.Boolean	isChild(java.lang.String concept1, java.lang.String concept2) Checks if the first concept is a subconcept of the second concept.
java.lang.Boolean	isChild(java.lang.String concept1, java.lang.String concept2, int namespaceId) Checks if the first concept is a subconcept of the second concept.
java.lang.Boolean	isChildByCode(java.lang.String concept1, java.lang.String concept2) Checks if a code belongs to a subconcept of a concept with a specific code
java.lang.Boolean	isChildByCode(java.lang.String concept1, java.lang.String concept2, int namespaceId) Determines if the firest concept (with cide concept1) is a subconcept of the second concept (with code concept2).
java.lang.Boolean	isComplex(java.lang.String propValue) Determines if property is Complex
boolean	isComplexProperty(java.lang.String propValue) Deprecated. replaced by isComplex(String) since DTSRPC 1.3.1
boolean	isConceptEdited(int namespaceId, java.lang.String inCode, boolean mrg_splt, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Checks if the specified concept is edited or not during a date range.
boolean	isConceptEdited(java.lang.String inCode, boolean mrg_splt, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Checks if the specified concept is edited or not during a date range.
boolean	isConceptRetired(int namespaceId, java.lang.String inCode) Deprecated. replaced by isRetired(java.lang.String) since DTSRPC 1.3.1
boolean	isConceptRetired(java.lang.String inCode) Deprecated. replaced by isRetired(java.lang.String) since DTSRPC 1.3.1
java.lang.Boolean	isEdited(int namespaceId, java.lang.String inCode, boolean mrg_splt, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Checks if the specified concept is edited or not during a date range.
java.lang.Boolean	isEdited(java.lang.String inCode, boolean mrg_splt, java.util.Date iBaselineDate_in, java.util.Date fBaselineDate_in) Checks if the specified concept is edited or not during a date range.
java.lang.Boolean	isRetired(int namespaceId, java.lang.String inCode) Checks if the specified concept is retired or not.
java.lang.Boolean	isRetired(java.lang.String inCode) Checks if the specified concept is retired or not.
boolean	isSubConcept(java.lang.String concept1, java.lang.String concept2) Checks if the first concept is a subconcept of the second concept.
boolean	isSubConcept(java.lang.String concept1, java.lang.String concept2, int namespaceId) Deprecated. replaced by isChild(java.lang.String, java.lang.String) since DTSRPC 1.3.1
boolean	isSubConceptByCode(java.lang.String concept1, java.lang.String concept2) Checks if a code belongs to a subconcept of the specifiedc concept
boolean	isSubConceptByCode(java.lang.String concept1, java.lang.String concept2, int namespaceId) Deprecated. replaced by isChildByCode(String,String) since DTSRPC 1.3.1
java.lang.Boolean	isSubConceptById(int conceptId1, int conceptId2) Checks if the concept with id conceptId1 is a subconcept of the concept with id conceptI2
java.lang.Boolean	isSubConceptById(int conceptId1, int conceptId2, int namespaceId) Checks if the concept with id conceptId1 is a subconcept of the concept with id conceptI2
java.lang.Boolean	isSubConceptByName(java.lang.String concept1, java.lang.String concept2) Determines if concept1 is a subconcept of concept2 in the specified namespace.
java.lang.Boolean	isSubConceptByName(java.lang.String concept1, java.lang.String concept2, int namespaceId) Determines if concept1 is a subconcept of concept2 in the specified namespace.
java.util.Vector	isSubConceptByName(java.lang.String concept1, java.util.Vector concepts_in) Determines if concept1 is a subconcept of a collection of concepts in the specified namespace.
java.util.Vector	isSubConceptByName(java.lang.String concept1, java.util.Vector concepts_in, int namespaceId) Determines if concept1 is a subconcept of a collection of concepts in the specified namespace.
boolean	isTreeDataAvailable() Checks if tree data are available.
boolean	isUp() Checks if the server connection is up.
boolean	isValidHistoryDate(java.util.Date historydate) Determines if a date is a valid history date.
java.util.Vector	parseDefinitionProperty(java.lang.String definitionValue) Parses DEFINITION property
java.util.Vector	parseFullSynProperty(java.lang.String propValue) Parses FULL_SYN property
java.lang.String	ping(boolean db) ping DTS Server .
int	PingServer() Ping DTS Server .
void	printTree(java.io.PrintWriter treeWriter, javax.swing.tree.DefaultMutableTreeNode root) Print a tree (UserObject is a Concept instance).
Concept[]	searchConcepts(int namespaceId, java.lang.String pattern, int searchLimit) Searches concepts in a given namespace that match with a specific search criteria
Concept[]	searchConcepts(int namespaceId, java.lang.String pattern, int limit, int matchOption, java.lang.String matchType, int ASDIndex) Searches concepts in accordance with user specified search criteria
Concept[]	searchConcepts(SearchCriteria sc) Searches concepts in accordance with search criteria as defined in a SearchCriteria object
Concept[]	searchConcepts(java.lang.String pattern, int searchLimit) Searches concepts that match with a specific search criteria
Concept[]	searchConcepts(java.lang.String pattern, int limit, int matchOption, java.lang.String matchType, int ASDIndex) Searches concepts in accordance with user specified search criteria
java.util.Vector	searchSilo(java.lang.String pattern, int limit) Searches for the specified pattern using the given search specification and returns an array of matches.
boolean	setDefaultNamespaceId(int nsid) Sets default namespaceID.
java.lang.Boolean	setVocabulary(java.lang.String name) Sets active vocabulary name
java.lang.Boolean	setVocabulary(java.lang.String name, java.lang.String key) Sets active vocabulary name with authentication (Note: This method has not yet been fully implemented.
boolean	setVocabularyName(java.lang.String name) Deprecated. replaced by setVocabulary(String) since DTSRPC 1.3.1
java.util.Vector	sortMatchedTerms(java.util.Vector matchedterm_vec, int first_by) Sorts MatchedTerm objects.
java.util.Vector	sortMatchedTerms(java.util.Vector matchedterm_vec, int first_by, int next_by) Sorts MatchedTerm objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PING_SUCCESS

public static final int PING_SUCCESS

A constant, 0, indicating that no failure mode is encountered.

See Also:

Constant Field Values

PING_DTS_SERVER_DOWN

public static final int PING_DTS_SERVER_DOWN

Ping server failure mode 1 -- DTS server is down.

See Also:

Constant Field Values

PING_DTS_DATABASE_DOWN

public static final int PING_DTS_DATABASE_DOWN

Ping server failure mode 2 -- DTS database server is down.

See Also:

Constant Field Values

PING_DTS_COMMUNICATION_DOWN

public static final int PING_DTS_COMMUNICATION_DOWN

Ping server failure mode 3 -- DTS communication is down.

See Also:

Constant Field Values

PING_RPC_FAILURE

public static final int PING_RPC_FAILURE

Ping server failure mode 4 -- XML-RPC exception.

See Also:

Constant Field Values

NO_HISTORY_DATE

public static java.util.Date NO_HISTORY_DATE

A constant date (January 1, 1970)

EDIT_ACTION_CREATE_STR

public static final java.lang.String EDIT_ACTION_CREATE_STR

Constant string for Create action

See Also:

Constant Field Values

EDIT_ACTION_MERGE_STR

public static final java.lang.String EDIT_ACTION_MERGE_STR

Constant string for Merge action

See Also:

Constant Field Values

EDIT_ACTION_MODIFY_STR

public static final java.lang.String EDIT_ACTION_MODIFY_STR

Constant string for Modify action

See Also:

Constant Field Values

EDIT_ACTION_RETIRE_STR

public static final java.lang.String EDIT_ACTION_RETIRE_STR

Constant string for Retire action

See Also:

Constant Field Values

EDIT_ACTION_SPLIT_STR

public static final java.lang.String EDIT_ACTION_SPLIT_STR

Constant string for Split action

See Also:

Constant Field Values

NAMESPACE_TYPE_CONNECTION

public static final java.lang.String NAMESPACE_TYPE_CONNECTION

Constant string for NAMESPACE_TYPE_CONNECTION

See Also:

Constant Field Values

NAMESPACE_TYPE_ONTYLOG

public static final java.lang.String NAMESPACE_TYPE_ONTYLOG

Constant string for NAMESPACE_TYPE_ONTYLOG

See Also:

Constant Field Values

NAMESPACE_TYPE_THESAURUS

public static final java.lang.String NAMESPACE_TYPE_THESAURUS

Constant string for NAMESPACE_TYPE_THESAURUS

See Also:

Constant Field Values

CONCEPT_STATUS

public static java.lang.String CONCEPT_STATUS

a static string "Concept_Status"

useTitleCase

public boolean useTitleCase

a boolean variable true, if apply title case conversion; false, otherwise

Constructor Detail

DTSRPCClient

public DTSRPCClient()

a constructor for creating an instance of DTSRPCClient.

Since:

DTSRPC 1.0

DTSRPCClient

public DTSRPCClient(java.lang.String ip,
                    java.lang.String port)

a constructor for creating an instance of DTSRPCClient.

Parameters:

ip - IP

port - port

Since:

DTSRPC 1.0

Method Detail

setDefaultNamespaceId

public boolean setDefaultNamespaceId(int nsid)

Sets default namespaceID.

Parameters:

nsid - default namespace id

Returns:

null, if getNamespaces returns null; true, if nsid is not positive; false, otherwise

Since:

DTSRPC 1.3.3

isValidHistoryDate

public boolean isValidHistoryDate(java.util.Date historydate)

Determines if a date is a valid history date.

Parameters:

historydate - input date

Returns:

True, if it's a valid history date; False, otherwise.

Since:

DTSRPC 1.3.3

setVocabularyName

public boolean setVocabularyName(java.lang.String name)

Deprecated. replaced by setVocabulary(String) since DTSRPC 1.3.1

Sets active vocabulary name

Parameters:

name - set active vocabulary to the specified vocabulary name

Returns:

boolean true if the vocabulary exists; false, if it's not.

Since:

DTSRPC 1.0

setVocabulary

public java.lang.Boolean setVocabulary(java.lang.String name,
                                       java.lang.String key)

Sets active vocabulary name with authentication (Note: This method has not yet been fully implemented. Use setVocabulary(String) instead)

Parameters:

name - set active vocabulary to the specified vocabulary name

key - string for authentication use.

Returns:

Boolean true if the vocabulary exists; false, if it's not; null, if an exception is thrown.

Since:

DTSRPC 2.1

setVocabulary

public java.lang.Boolean setVocabulary(java.lang.String name)

Sets active vocabulary name

Parameters:

name - set active vocabulary to the specified vocabulary name

Returns:

Boolean true if the vocabulary exists; false, if it's not; null, if an exception is thrown.

Since:

DTSRPC 1.3.1

getVocabularyNames

public java.util.Vector getVocabularyNames()

Gets available vocabulary names

Returns:

a vector containing names of all the available vocabularies; null, if an exception is thrown.

Since:

DTSRPC 1.0

getVocabularyDescription

public java.lang.String getVocabularyDescription(java.lang.String name)

Gets the description of a vocabulary

Parameters:

name - vocabulary name

Returns:

description of the specified vocabulary; return null, if an exception is thrown.

Since:

DTSRPC 1.0

getNamespaceId

public int getNamespaceId(java.lang.String namespaceName)

Gets the relative id of a namespace

Parameters:

namespaceName - namespace name

Returns:

the relative id of a namespace; return -1, if an exception is thrown.

Since:

DTSRPC 2.0

getVocabularyHost

public java.lang.String getVocabularyHost(java.lang.String name)

Gets the host of a vocabulary server

Parameters:

name - the specified vocabulary name

Returns:

the host of a vocabulary server; return null, if an exception is thrown.

Since:

DTSRPC 1.0

getNamespaces

public java.util.Vector getNamespaces()

Gets available namespaces in a knowledgebase Note: in DTS 3.0, each connection is associated with a knowledgebase Each knowledgebase can contain multiple namespaces

Returns:

a vector containing names of all the available namespaces; null, if an exception is thrown.

Since:

DTSRPC 2.0

getConceptCodeByName

public java.lang.String getConceptCodeByName(java.lang.String conceptname)

Finds the code of the specified concept.

Parameters:

conceptname - the specified concept name

Returns:

the specified concept code; return null, if connection fails or an exception is thrown.

Since:

DTSRPC 1.0

getConceptCodeByName

public java.lang.String getConceptCodeByName(java.lang.String conceptname,
                                             int namespaceId)

Finds the code of the specified concept.

Parameters:

conceptname - the specified concept name

namespaceId - namespace id

Returns:

the specified concept code; return null, if connection fails or an exception is thrown.

Since:

DTSRPC 1.0

getConceptNameByCode

public java.lang.String getConceptNameByCode(java.lang.String conceptcode)

Finds the code of the specified concept.

Parameters:

conceptcode - concept code

Returns:

the specified concept code; return null, if connection fails or an exception is thrown.

Since:

DTSRPC 1.0

getConceptNameByCode

public java.lang.String getConceptNameByCode(java.lang.String conceptcode,
                                             int namespaceId)

Finds the code of the specified concept.

Parameters:

conceptcode - the specified concept code

namespaceId - namespace id

Returns:

the specified concept code; return null, if connection fails or an exception is thrown.

Since:

DTSRPC 1.0

findConceptsWithRoleOrPropertyMatching

public java.util.Vector findConceptsWithRoleOrPropertyMatching(java.lang.String infixExpression)

Performs complex search for concepts that match a search criteria defined by roles, properties, and binary operators, AND, OR, and NOT. For example, if the search expression (infixExpression) is R|role name|role value AND P|property name|property value, then the search will return concepts that have a role value and a property value matching with the values as specified in the search expression string.

Parameters:

infixExpression - search expression

Returns:

a vector of names of concepts matching the specific search criteria

findConceptsWithRoleOrPropertyMatching

public java.util.Vector findConceptsWithRoleOrPropertyMatching(int namespaceId,
                                                               java.lang.String infixExpression)

Finds concepts with roles or properties matching with a specific search criteria.

Parameters:

namespaceId - namespace id

infixExpression - search expression

Returns:

a vector of names of concepts matching the specific search criteria

hasStatus

public java.lang.Boolean hasStatus(java.lang.String conceptname)

a boolean variable indicating whether the concept has a concept status

Parameters:

conceptname - concept name

Returns:

true, if the concept has at least one concept status; false. otherwise

Since:

DTSRPC 2.0

hasStatus

public java.lang.Boolean hasStatus(java.lang.String conceptname,
                                   int namespaceId)

Checks if a concept has any status.

Parameters:

conceptname - concept name

namespaceId - namespace id

Returns:

true, if the concept has at least one concept status; false. otherwise

Since:

DTSRPC 2.0

getConceptStatus

public java.util.Vector getConceptStatus(java.lang.String conceptname)

Gets the status of the specific concept

Parameters:

conceptname - concept name

Returns:

the status of the specific concept

Since:

DTSRPC 2.0

getConceptStatus

public java.util.Vector getConceptStatus(java.lang.String conceptname,
                                         int namespaceId)

Gets the status of the specific concept

Parameters:

conceptname - concept name

namespaceId - namespace id

Returns:

the status of the specific concept

Since:

DTSRPC 2.0

getVocabularyVersion

public java.lang.String getVocabularyVersion(java.lang.String name)

Gets vocabulary name (a vocabulary name maps to a tuple)

Parameters:

name - vocabulary name

Returns:

vocabulary name

Since:

DTSRPC 2.0

getVocabularyPort

public java.lang.String getVocabularyPort(java.lang.String name)

Gets the port of a vocabulary server

Parameters:

name - the specified vocabulary name

Returns:

the port of a vocabulary server; return null, if an exception is thrown.

Since:

DTSRPC 1.0

getCreationDate

public java.util.Date getCreationDate(java.lang.String inCode)

Gets the creation date of a concept

Parameters:

inCode - concept code

Returns:

the creation date of a concept

Since:

DTSRPC 2.0

getHistoryStartDate

public java.util.Date getHistoryStartDate()

Gets history starting date

Returns:

history starting date

Since:

DTSRPC 2.0

getHistoryEndDate

public java.util.Date getHistoryEndDate()

Gets history end date

Returns:

history end date

Since:

DTSRPC 2.0

parseFullSynProperty

public java.util.Vector parseFullSynProperty(java.lang.String propValue)

Parses FULL_SYN property

Parameters:

propValue - property value

Returns:

an array of complex property values, which are term-name, term-group, and term-source; return null, if an exception is thrown.

Since:

DTSRPC 1.0

isComplexProperty

public boolean isComplexProperty(java.lang.String propValue)

Deprecated. replaced by isComplex(String) since DTSRPC 1.3.1

Determines if property is Complex

Parameters:

propValue - property value

Returns:

boolean specifying whether property is of complex type or XML format.

Since:

DTSRPC 1.0

isComplex

public java.lang.Boolean isComplex(java.lang.String propValue)

Determines if property is Complex

Parameters:

propValue - property value

Returns:

boolean specifying whether property is of complex type or XML format; return null, if an exception is thrown.

Since:

DTSRPC 1.3.1

getComplexPropertyElements

public java.util.Vector getComplexPropertyElements(java.lang.String propValue)

Gets tag names in a XML formatted sString

Parameters:

propValue - property value

Returns:

a vector of all the element names in the specified property value; return null, if an exception is thrown.

Since:

DTSRPC 1.0

getComplexPropertyElementValue

public java.lang.String getComplexPropertyElementValue(java.lang.String element,
                                                       java.lang.String propValue)

Gets the value associated with the element in the property value

Parameters:

element - the tag element value to be retrieved

propValue - the complex Property value for which to search the element

Returns:

a string containing the value of the corresponding given element; return null, if an exception is thrown.

Since:

DTSRPC 1.0

parseDefinitionProperty

public java.util.Vector parseDefinitionProperty(java.lang.String definitionValue)

Parses DEFINITION property

Parameters:

definitionValue - the specified definitionValue value

Returns:

an array of complex property values, which are def-source and def-definition; return null, if an exception is thrown.

Since:

DTSRPC 1.0

findConceptWithRoleMatching

public java.util.Vector findConceptWithRoleMatching(java.lang.String rolename,
                                                    java.lang.String pattern,
                                                    int matchLimit)

Gets all concepts that have a role value of the given role that matches the argument pattern.

Parameters:

rolename - all returned concepts should have this role.

pattern - concept role value pattern for searching.

matchLimit - maximum number of records

Returns:

a vector of names of concepts that have a role value matching the pattern; null, if an exception is thrown.

Since:

DTSRPC 1.0

findConceptWithPropertyMatching

public java.util.Vector findConceptWithPropertyMatching(java.lang.String propertyname,
                                                        java.lang.String pattern,
                                                        int matchLimit)

Gets all concepts that have a property value of the given property that matches the argument pattern.

Parameters:

propertyname - all returned concepts should have the value of this Property.

pattern - concept property value pattern for searching

matchLimit - maximum number of records

Returns:

a vector of Concept objects that have a property value matching the pattern. An empty vector is returned when there were no matches. Return null, if an exception is thrown.

Since:

DTSRPC 1.0

getMatches

public java.util.Vector getMatches(java.lang.String pattern,
                                   int matchLimit)

Searches for concept names that partially match with the search pattern.

Parameters:

pattern - search pattern string

matchLimit - the maximum number of matches to be returned

Returns:

a vector containing concept names that partially match with the search pattern; null, if an exception is thrown.

Since:

DTSRPC 1.0

getRoleNames

public java.util.Vector getRoleNames(java.lang.String conceptname)

Gets the names of roles owned by a specific concept (in the default namespace)

Parameters:

conceptname - concept name

Returns:

the name of a specific concept

getRoleNames

public java.util.Vector getRoleNames(java.lang.String conceptname,
                                     int namespaceId)

Gets the names of all roles owned by the specified concept.

Parameters:

conceptname - the specified concept name

namespaceId - namespace id

Returns:

a vector containing the names of roles owned by the specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getRoleValues

public java.util.Vector getRoleValues(java.lang.String conceptname,
                                      java.lang.String rolename)

Gets the values of a role owned by a particular concept

Parameters:

conceptname - concept name

rolename - role name

Returns:

the values of a role owned by a particular concept

getRoleValues

public java.util.Vector getRoleValues(java.lang.String conceptname,
                                      java.lang.String rolename,
                                      int namespaceId)

Gets the values of a particular role owned by the specified concept.

Parameters:

conceptname - the specified concept name

rolename - the specified role name

namespaceId - namespace id

Returns:

the values of a particular role owned by the specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getPropertyNames

public java.util.Vector getPropertyNames(java.lang.String conceptname)

Gets the names of all roles owned by the specified concept (in the default namespace).

Parameters:

conceptname - the specified concept name

Returns:

the names of all roles owned by the specified concept

getPropertyNames

public java.util.Vector getPropertyNames(java.lang.String conceptname,
                                         int namespaceId)

Gets the names of all properties owned by the specified concept.

Parameters:

conceptname - the specified concept name

namespaceId - namespace id

Returns:

a vector containing the names of properties owned by the specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getPropertyValues

public java.util.Vector getPropertyValues(java.lang.String conceptname,
                                          java.lang.String propertyname)

Gets the values of a propertyies owned by a concept in the default name space

Parameters:

conceptname - concept name

propertyname - property name

Returns:

the values of properties owned by a concept in the default name space

getPropertyValues

public java.util.Vector getPropertyValues(java.lang.String conceptname,
                                          java.lang.String propertyname,
                                          int namespaceId)

Gets the values of a particular properties owned by the specified concept in a given namespace.

Parameters:

conceptname - the specified concept name

propertyname - the specified property name

namespaceId - namespace id

Returns:

the values of a particular property owned by the specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getRolesByConceptName

public java.util.Vector getRolesByConceptName(java.lang.String conceptname)

Gets the names and values of roles owned by the specified concept in the default namespace.. Each name and value pair is returned as a string delimited by a '$' sign (i.e., name$value).

Parameters:

conceptname - concept name

Returns:

names and values of all roles owned by a concept in the default namespace

getRolesByConceptName

public java.util.Vector getRolesByConceptName(java.lang.String conceptname,
                                              int namespaceId)

Gets the names and values of roles owned by the specified concept. Each name and value pair is returned as a string delimited by a '$' sign (i.e., name$value).

Parameters:

conceptname - the specified concept name

namespaceId - namespace id

Returns:

a vector containing the names and values of roles owned by a specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getPropertiesByConceptName

public java.util.Vector getPropertiesByConceptName(java.lang.String conceptname)

Gets the names and values of properties owned by the specified concept. Each name and value pair is returned as a string delimited by a '$' sign (i.e., name$value).

Parameters:

conceptname - the specified concept name

Returns:

a vector containing the names and values of properties owned by a specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getPropertiesByConceptName

public java.util.Vector getPropertiesByConceptName(java.lang.String conceptname,
                                                   int namespaceId)

Gets the names and values of properties owned by the specified concept. Each name and value pair is returned as a string delimited by a '$' sign (i.e., name$value).

Parameters:

conceptname - the specified concept name

namespaceId - namespace id

Returns:

a vector containing the names and values of properties owned by a specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getSuperConcepts

public java.util.Vector getSuperConcepts(java.lang.String inputvalue,
                                         java.lang.Boolean inputcodeObj,
                                         java.lang.Boolean outputcodeObj)

Gets the codes (or the names) of all superconcepts of the specified concepts.

Parameters:

inputvalue - code or the specified concept name

inputcodeObj - a Boolean true - if inputvalue is a concept code ; false - it is a concept name.

outputcodeObj - a Boolean true - if returned value is a concept code ; false - it is a concept name.

Returns:

a vector containing the codes (or the names) of all superconcepts of the specified concepts; null, if an exception is thrown.

Since:

DTSRPC 1.0

getSuperConcepts

public java.util.Vector getSuperConcepts(java.lang.String inputvalue,
                                         boolean inputcode,
                                         boolean outputcode)

Gets the codes (or the names) of all superconcepts of the specified concepts.

Parameters:

inputvalue - code or the specified concept name

inputcode - a Boolean true - if inputvalue is a concept code ; false - it is a concept name.

outputcode - a Boolean true - if returned value is a concept code ; false - it is a concept name.

Returns:

a vector containing the codes (or the names) of all superconcepts of the specified concepts; null, if an exception is thrown.

Since:

DTSRPC 1.0

getSuperConcepts

public java.util.Vector getSuperConcepts(java.lang.String inputvalue,
                                         boolean inputcode,
                                         boolean outputcode,
                                         int namespaceId)

Gets the codes (or the names) of all superconcepts of the specified concepts.

Parameters:

inputvalue - code or the specified concept name

inputcode - a Boolean true - if inputvalue is a concept code ; false - it is a concept name.

outputcode - a Boolean true - if returned value is a concept code ; false - it is a concept name.

namespaceId - namespace id

Returns:

a vector containing the codes (or the names) of all superconcepts of the specified concepts; null, if an exception is thrown.

Since:

DTSRPC 1.0

getSubConcepts

public java.util.Vector getSubConcepts(java.lang.String inputvalue,
                                       java.lang.Boolean inputcodeObj,
                                       java.lang.Boolean outputcodeObj,
                                       int namespaceId)

Gets the names (or the codes) of a given concept in a specific namespace

Parameters:

inputvalue - input name (or code)

inputcodeObj - a Boolean true - if returned value is a concept code ; false - it is a concept name.

outputcodeObj - a Boolean true - if returned value is a concept code ; false - it is a concept name.

namespaceId - namespace id

Returns:

the names (or the codes) of a given concept in a specific namespace

getSubConcepts

public java.util.Vector getSubConcepts(java.lang.String inputvalue,
                                       java.lang.Boolean inputcodeObj,
                                       java.lang.Boolean outputcodeObj)

Gets the codes, or the names, of all subconcepts of the specified concept

Parameters:

inputvalue - code or the specified concept name

inputcodeObj - a Boolean true - if returned value is a concept code ; false - it is a concept name.

outputcodeObj - a boolean true - if returned value is a concept code ; false - it is a concept name.

Returns:

a vector containing the codes, or the names, of all subconcepts of the specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getSubConcepts

public java.util.Vector getSubConcepts(java.lang.String inputvalue,
                                       boolean inputcode,
                                       boolean outputcode)

Gets the codes, or the names, of all subconcepts of the specified concept

Parameters:

inputvalue - code or the specified concept name

inputcode - a boolean true - if inputvalue is a concept code; false - it is a concept name.

outputcode - a boolean true - if returned value is a concept code ; false - it is a concept name.

Returns:

a vector containing the codes, or the names, of all subconcepts of the specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getSubConcepts

public java.util.Vector getSubConcepts(java.lang.String inputvalue,
                                       boolean inputcode,
                                       boolean outputcode,
                                       int namespaceId)

Gets the codes, or the names, of all subconcepts of the specified concept

Parameters:

inputvalue - code or the specified concept name

inputcode - a boolean true - if inputvalue is a concept code; false - it is a concept name.

outputcode - a boolean true - if returned value is a concept code ; false - it is a concept name.

namespaceId - namespace id

Returns:

a vector containing the codes, or the names, of all subconcepts of the specified concept; null, if an exception is thrown.

Since:

DTSRPC 1.0

getAllRoleNames

public java.util.Vector getAllRoleNames()

Gets all role names defined in the default namespace

Returns:

all role names defined in the default namespace

Since:

DTSRPC 2.0

getAllRoleNames

public java.util.Vector getAllRoleNames(int namespaceId)

Gets the role names defined in a particular namespace.

Parameters:

namespaceId - namespace id

Returns:

a vector of role names defined in a particular namespace.

Since:

DTSRPC 2.0

getConceptEditActionDates

public java.util.Vector getConceptEditActionDates(java.lang.String inCode,
                                                  java.lang.String action)

Gets EditActionDate that match with the given concept code and edit action index.

Parameters:

inCode - concept code

action - edit action index

Returns:

a vector of String representing EditActionDate objects that match with the given concept code and edit action index.

Since:

DTSRPC 2.0

getConceptEditActionDates

public java.util.Vector getConceptEditActionDates(java.lang.String inCode,
                                                  int iAction)

Gets EditActionDate that match with the given concept code and edit action index.

Parameters:

inCode - concept code

iAction - edit action index

Returns:

a vector of String representing EditActionDate objects that match with the given concept code

Since:

DTSRPC 2.0

getConceptEditActionDates

public java.util.Vector getConceptEditActionDates(int namespaceId,
                                                  java.lang.String inCode,
                                                  int iAction)

Gets EditActionDate that match with the given concept code and edit action index.

Parameters:

namespaceId - namespace id

inCode - concept code

iAction - edit action index

Returns:

a vector of String representing EditActionDate objects that match with the given concept code

Since:

DTSRPC 2.0

isSubConceptByCode

public boolean isSubConceptByCode(java.lang.String concept1,
                                  java.lang.String concept2)

Checks if a code belongs to a subconcept of the specifiedc concept

Parameters:

concept1 - the code of the first concept (subconcept)

concept2 - the code of the second concept (superconcept)

Returns:

true, it it's a subconcept; false, otherwise

isSubConceptByCode

public boolean isSubConceptByCode(java.lang.String concept1,
                                  java.lang.String concept2,
                                  int namespaceId)

Deprecated. replaced by isChildByCode(String,String) since DTSRPC 1.3.1

Checks if a code belongs to a subconcept of a concept with a specific code

Parameters:

concept1 - the code of the first concept (subconcept)

concept2 - the code of the first concept (superconcept)

namespaceId - namespace id

Returns:

a boolean. true if concept1 is a sub concept of concept2, false if concept1 isn't a sub concept of concept2.

Since:

DTSRPC 1.0

isChildByCode

public java.lang.Boolean isChildByCode(java.lang.String concept1,
                                       java.lang.String concept2)

Checks if a code belongs to a subconcept of a concept with a specific code

Parameters:

concept1 - the subconcept code

concept2 - the superconcept code

Returns:

a Boolean object. Set to true, if it is; false, otherwise

isChildByCode

public java.lang.Boolean isChildByCode(java.lang.String concept1,
                                       java.lang.String concept2,
                                       int namespaceId)

Determines if the firest concept (with cide concept1) is a subconcept of the second concept (with code concept2).

Parameters:

concept1 - the code of the first concept

concept2 - the code of the second concept

namespaceId - namespace id

Returns:

a Boolean. true if concept1 is a sub concept of concept2, false if concept1 isn't a sub concept of concept2; null, if an exception is thrown.

Since:

DTSRPC 1.3.1

getPropertyTypes

public java.util.Vector getPropertyTypes()

Gets the names of all property types

Returns:

a vector containing the names of all property types

Since:

DTSRPC 2.0

getMatchedTerms

public java.util.Vector getMatchedTerms(java.lang.String pattern,
                                        int searchLimit)

Finds terms that match with a specific pattern.

Parameters:

pattern - search pattern

searchLimit - maximum number of MatchedTerm to return

Returns:

A vector of MatchedTerm objects

getMatchedTerms

public java.util.Vector getMatchedTerms(java.lang.String pattern,
                                        int searchLimit,
                                        java.util.Vector namespace_vec,
                                        java.util.Vector kind_vec)

Finds terms that match with a specific pattern.

Parameters:

pattern - search pattern

searchLimit - maximum number of MatchedTerm to return

namespace_vec - a vector of namespace names

kind_vec - a vector of kind names

Returns:

A vector of MatchedTerm objects

getMatchedTerms

public java.util.Vector getMatchedTerms(java.lang.String pattern,
                                        int initial_index,
                                        int final_index)

Finds terms that match with a specific pattern.

Parameters:

pattern - search pattern

initial_index - initial index

final_index - final index

Returns:

A vector of MatchedTerm objects

getMatchedTerms

public java.util.Vector getMatchedTerms(java.lang.String pattern,
                                        int initial_index,
                                        int final_index,
                                        java.util.Vector namespace_vec,
                                        java.util.Vector kind_vec)

Finds terms that match with a specific pattern.

Parameters:

pattern - search pattern

initial_index - initial index

final_index - final index

namespace_vec - a vector of namespace names

kind_vec - a vector of kind names

Returns:

A vector of MatchedTerm objects

getMatchedTermCount

public java.lang.Integer getMatchedTermCount(java.lang.String pattern)

Gets the total number of matched terms.

Parameters:

pattern - search pattern

Returns:

the matched term count

getMatchedTermCount

public java.lang.Integer getMatchedTermCount(java.lang.String pattern,
                                             java.util.Vector namespace_vec,
                                             java.util.Vector kind_vec)

Gets the total number of matched terms.

Parameters:

pattern - search pattern

namespace_vec - a vector of namespace names

kind_vec - a vector of kind names

Returns:

the matched term count

getNamespaceDescription

public java.lang.String getNamespaceDescription(java.lang.String namespaceName)

Gets the description of a specific namespace

Parameters:

namespaceName - namespace name

Returns:

the description of a specific namespace

sortMatchedTerms

public java.util.Vector sortMatchedTerms(java.util.Vector matchedterm_vec,
                                         int first_by)

Sorts MatchedTerm objects.

Parameters:

matchedterm_vec - an input vector containing MatchedTerm objects

first_by - the index of a member variable of MatchedTerm

Returns:

a vector containing sorted MatchedTerm objects

sortMatchedTerms

public java.util.Vector sortMatchedTerms(java.util.Vector matchedterm_vec,
                                         int first_by,
                                         int next_by)

Sorts MatchedTerm objects.

Parameters:

matchedterm_vec - an input vector containing MatchedTerm objects

first_by - the index of the first member variable of MatchedTerm

next_by - the index of the second member variable of MatchedTerm

Returns:

a vector containing sorted MatchedTerm objects

hasSubconcepts

public boolean hasSubconcepts(java.lang.String conceptname)

Checks if a concept in the default namespace has any subconcept

Parameters:

conceptname - concept name

Returns:

true, if the concept has subconcepts; false, otherwise

Since:

DTSRPC 2.0

hasSubconcepts

public boolean hasSubconcepts(java.lang.String conceptname,
                              int namespaceId)

Deprecated. replaced by hasChildren(java.lang.String) since DTSRPC 1.3.1

Checks if a concept in a namespace) has any subconcept

Parameters:

conceptname - concept name

namespaceId - namespace id

Returns:

true, if the concept has subconcepts; false, otherwise

Since:

DTSRPC 2.0

hasChildren

public java.lang.Boolean hasChildren(java.lang.String conceptname)

Checks if a concept in the default namespace has any subconcept

Parameters:

conceptname - concept name

Returns:

true, if the concept has subconcepts; false, otherwise

Since:

DTSRPC 2.0

hasChildren

public java.lang.Boolean hasChildren(java.lang.String conceptname,
                                     int namespaceId)

Checks if a concept in a namespace has any subconcepts.

Parameters:

conceptname - concept name

namespaceId - namespace id

Returns:

true, if a concept in a namespace has subconcepts; false, otherwise.

Since:

DTSRPC 2.0

isSubConcept

public boolean isSubConcept(java.lang.String concept1,
                            java.lang.String concept2)

Checks if the first concept is a subconcept of the second concept.

Parameters:

concept1 - the name of the first concept

concept2 - the name of the second concept

Returns:

true, if the first concept is a subconcept of the second concept; false. otherwise

Since:

DTSRPC 2.0

isSubConcept

public boolean isSubConcept(java.lang.String concept1,
                            java.lang.String concept2,
                            int namespaceId)

Deprecated. replaced by isChild(java.lang.String, java.lang.String) since DTSRPC 1.3.1

Checks if the first concept is a subconcept of the second concept.

Parameters:

concept1 - the name of the first concept

concept2 - the name of the second concept

namespaceId - namespace id

Returns:

true, if the first concept is a subconcept of the second concept; false. otherwise

Since:

DTSRPC 2.0

isChild

public java.lang.Boolean isChild(java.lang.String concept1,
                                 java.lang.String concept2)

Checks if the first concept is a subconcept of the second concept.

Parameters:

concept1 - the name of the first concept

concept2 - the name of the second concept

Returns:

true, if the first concept is a subconcept of the second concept; false. otherwise

Since:

DTSRPC 2.0

isChild

public java.lang.Boolean isChild(java.lang.String concept1,
                                 java.lang.String concept2,
                                 int namespaceId)

Checks if the first concept is a subconcept of the second concept.

Parameters:

concept1 - the name of the first concept

concept2 - the name of the second concept

namespaceId - namespace id

Returns:

true, if the first concept is a subconcept of the second concept; false. otherwise

Since:

DTSRPC 2.0

getAllSubConceptNames

public java.util.Vector getAllSubConceptNames(java.lang.String conceptName)

Gets the names of all subconcept of a specified concept

Parameters:

conceptName - concept name

Returns:

a vector containing the names of all subconcept of a specified concept

Since:

DTSRPC 2.0

getAllSubConceptNames

public java.util.Vector getAllSubConceptNames(java.lang.String conceptName,
                                              int namespaceId)

Gets the names of all subconcept of a specified concept

Parameters:

conceptName - concept name

namespaceId - namespace id

Returns:

a vector containing the names of all subconcept of a specified concept

Since:

DTSRPC 2.0

getAllSubConceptCodes

public java.util.Vector getAllSubConceptCodes(java.lang.String conceptCode)

Gets the codes of all subconcept of a specified concept

Parameters:

conceptCode - concept code

Returns:

a vector containing the codes of all subconcept of a specified concept

Since:

DTSRPC 2.0

getAllSubConceptCodes

public java.util.Vector getAllSubConceptCodes(java.lang.String conceptCode,
                                              int namespaceId)

Gets the codes of all subconcept of a specified concept

Parameters:

conceptCode - concept code

namespaceId - namespace id

Returns:

a vector containing the codes of all subconcept of a specified concept

Since:

DTSRPC 2.0

hasSuperconcepts

public boolean hasSuperconcepts(java.lang.String conceptname)

Checks if a concept has any superconcept

Parameters:

conceptname - concept name

Returns:

boolean true, if a concept has any superconcept; false, otherwise

Since:

DTSRPC 2.0

hasSuperconcepts

public boolean hasSuperconcepts(java.lang.String conceptname,
                                int namespaceId)

Deprecated. replaced by hasParents(java.lang.String) since DTSRPC 1.3.1

Checks if a concept has any superconcept

Parameters:

conceptname - concept name

namespaceId - namespace id

Returns:

boolean true, if a concept has any superconcept; false, otherwise

Since:

DTSRPC 2.0

hasParents

public java.lang.Boolean hasParents(java.lang.String conceptname)

Checks if a concept has any superconcept

Parameters:

conceptname - concept name

Returns:

boolean true, if a concept has any superconcept; false, otherwise

Since:

DTSRPC 2.0

hasParents

public java.lang.Boolean hasParents(java.lang.String conceptname,
                                    int namespaceId)

Checks if a concept has any superconcept .

Parameters:

conceptname - concept name

namespaceId - namespace id

Returns:

boolean true, if a concept has any superconcept; false, otherwise

Since:

DTSRPC 2.0

getNamespaceType

public java.lang.String getNamespaceType(java.lang.String namespaceName)

Gets namespace type .

Parameters:

namespaceName - name of Namespace

Returns:

namespace type

Since:

DTSRPC 2.0

PingServer

public int PingServer()

Ping DTS Server .

Returns:

the status of the server

Since:

DTSRPC 2.0

getTree

public javax.swing.tree.DefaultMutableTreeNode getTree(java.lang.String rootname,
                                                       boolean direction,
                                                       int levels,
                                                       AttributeSetDescriptor attributes,
                                                       boolean isaflag,
                                                       java.util.Vector rolenames,
                                                       int namespaceId)

Gets tree data.

Parameters:

rootname - the name of the root concept

direction - a boolean value; set to true, if traverse down; to false, otherwise

levels - the depth of the tree

attributes - an AttributeSetDescriptor instance (Note: To retrieve a subtree of a pre-cached mixed tree (graph), set this parameter to NO_ATTRIBUTES.)

isaflag - a boolean value; set to true, if the tree contains taxonomy (is a relationships); to false, otherwise

rolenames - the names of role relationships

namespaceId - namespace id

Returns:

a DefaultMutableTreeNode containing tree data

isCacheDone

public java.lang.String isCacheDone()

Gets tree caching status.

Returns:

a String containing tree caching status

Since:

DTSRPC 2.0

isTreeDataAvailable

public boolean isTreeDataAvailable()

Checks if tree data are available.

Returns:

true, if tree data are available; false, otherwise

Since:

DTSRPC 2.0

isUp

public boolean isUp()

Checks if the server connection is up.

Returns:

true, if the server is up; false, otherwise

Since:

DTSRPC 2.0

findTermsByName

public java.util.Vector findTermsByName(java.lang.String termname_in)

Finds terms that match with a specific search string

Parameters:

termname_in - term name (search criteria)

Returns:

a vector containing the IDs of terms that match with a specific search string

Since:

DTSRPC 2.0

findTermsByName

public java.util.Vector findTermsByName(java.lang.String termname_in,
                                        int namespaceId)

Finds terms that match with a specific search string

Parameters:

termname_in - term name (search criteria)

namespaceId - namespace id

Returns:

a vector containing the IDs of terms that match with a specific search string

Since:

DTSRPC 2.0

fetchDTSProperties

public java.util.Vector fetchDTSProperties(java.lang.String term_in)

Fetchs the properties of a givn concept belonging to a given namespace

Parameters:

term_in - a term name

Returns:

a vector containing the properties of a givn concept belonging to a given namespace

Since:

DTSRPC 2.0

fetchDTSProperties

public java.util.Vector fetchDTSProperties(java.lang.String term_in,
                                           int namespaceId)

Fetchs the properties of a givn concept belonging to a given namespace

Parameters:

term_in - a term name

namespaceId - namespace id

Returns:

a vector containing the properties of a givn concept belonging to a given namespace

Since:

DTSRPC 2.0

fetchTermAssociations

public java.util.Vector fetchTermAssociations(java.lang.String term_in)

Fetchs term association data corresponding to a concept belonging to a given namespace .

Parameters:

term_in - a term name

Returns:

term association data corresponding to a concept belonging to a given namespace

Since:

DTSRPC 2.0

fetchTermAssociations

public java.util.Vector fetchTermAssociations(java.lang.String term_in,
                                              int namespaceId)

Fetchs term association data corresponding to a concept belonging to a given namespace .

Parameters:

term_in - a term name

namespaceId - namespace id

Returns:

term association data corresponding to a concept belonging to a given namespace

Since:

DTSRPC 2.0

containsRole

public java.lang.Boolean containsRole(java.lang.String role_name,
                                      java.lang.String role_value,
                                      java.lang.String ontylogconcept_in)

Checks if a ontylog concept in a namespace has a specific role and if so whether the role has a specific value

Parameters:

role_name - role name

role_value - role value

ontylogconcept_in - the name of the specific ontylog concept

Returns:

A Boolean variable with value set to TRUE if it has; FALSE, otherwise

containsRole

public java.lang.Boolean containsRole(java.lang.String role_name,
                                      java.lang.String role_value,
                                      java.lang.String ontylogconcept_in,
                                      int namespaceId)

Checks if a ontylog concept in a namespace has a specific role and if so whether the role has a specific value

Parameters:

role_name - role name

role_value - role value

ontylogconcept_in - the name of the specific ontylog concept

namespaceId - namespace id

Returns:

A Boolean variable with value set to TRUE if it contains roles; FALSE, otherwise

containsInverseRole

public java.lang.Boolean containsInverseRole(java.lang.String role_name,
                                             java.lang.String role_value,
                                             java.lang.String ontylogconcept_in)

Checks if a ontylog concept in a namespace has a specific inverse role and if so whether the role has a specific value

Parameters:

role_name - role name

role_value - role value

ontylogconcept_in - the name of the specific ontylog concept

Returns:

A Boolean variable with value set to TRUE if it has; FALSE, otherwise

containsInverseRole

public java.lang.Boolean containsInverseRole(java.lang.String role_name,
                                             java.lang.String role_value,
                                             java.lang.String ontylogconcept_in,
                                             int namespaceId)

Checks if a ontylog concept in a namespace has a specific inverse role and if so whether the role has a specific value

Parameters:

role_name - role name

role_value - role value

ontylogconcept_in - the name of the specific ontylog concept

namespaceId - namespace id

Returns:

A Boolean variable with value set to TRUE if it contains inverse roles; FALSE, otherwise

isSubConceptByName

public java.lang.Boolean isSubConceptByName(java.lang.String concept1,
                                            java.lang.String concept2)

Determines if concept1 is a subconcept of concept2 in the specified namespace. Concept1 and concept2 are names of Ontylog concepts.

Parameters:

concept1 - - a concept name

concept2 - - a concept name

Returns:

true if concept1 is a subconcept of concept2, false if concept1 isn't a subconcept of concept2 Returns null, if there is an exception.

isSubConceptByName

public java.lang.Boolean isSubConceptByName(java.lang.String concept1,
                                            java.lang.String concept2,
                                            int namespaceId)

Determines if concept1 is a subconcept of concept2 in the specified namespace. Concept1 and concept2 are names of Ontylog concepts.

Parameters:

concept1 - - a concept name

concept2 - - a concept name

namespaceId - - namespace ID of the two Ontylog concepts

Returns:

true if concept1 is a subconcept of concept2, false if concept1 isn't a subconcept of concept2 Returns null, if there is an exception.

isSubConceptByName

public java.util.Vector isSubConceptByName(java.lang.String concept1,
                                           java.util.Vector concepts_in)

Determines if concept1 is a subconcept of a collection of concepts in the specified namespace.

Parameters:

concept1 - - a concept name

concepts_in - a list of concept names

Returns:

a vector of Boolean variables indicating whether concept1 is a subconcept of each concept in the list

Since:

DTSRPC 2.0

isSubConceptByName

public java.util.Vector isSubConceptByName(java.lang.String concept1,
                                           java.util.Vector concepts_in,
                                           int namespaceId)

Determines if concept1 is a subconcept of a collection of concepts in the specified namespace.

Parameters:

concept1 - - a concept name

concepts_in - a list of concept names

namespaceId - - namespace ID of the two Ontylog concepts

Returns:

a vector of Boolean variables indicating whether concept1 is a subconcept of each concept in the list

Since:

DTSRPC 2.0

getNamespaceNames

public java.util.Vector getNamespaceNames()

Gets namespace names

Returns:

a vector of namespace names

Since:

DTSRPC 2.0

getKindNames

public java.util.Vector getKindNames()

Gets kind names .

Returns:

a vector of kind names

Since:

DTSRPC 2.0

getAllAssociationTypes

public java.util.Vector getAllAssociationTypes()

Retrieves all association types known in the knowledgebase.

Returns:

An vector of all the AssociationTypes. Returns an empty array if there are no AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getAllConceptAssociationTypes

public java.util.Vector getAllConceptAssociationTypes()

Retrieves all concept association types.

Returns:

a vector of all the concept AssociationTypes. Returns an empty vector if there are no concept AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptAssociationTypes

public java.util.Vector getConceptAssociationTypes()

Retrieves all concept association types.

Returns:

a vector of all the concept AssociationTypes. Returns an empty vector if there are no concept AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptAssociationTypes

public java.util.Vector getConceptAssociationTypes(int namespaceId)

Retrieves all concept association types in a namespace.

Parameters:

namespaceId - - desired namespace ID of association types

Returns:

a vector of all the concept AssociationTypes in that namespace. Returns an empty vector if there are no concept AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getAllTermAssociationTypes

public java.util.Vector getAllTermAssociationTypes()

Retrieves all term association types.

Returns:

a vector of all term AssociationTypes. Returns an empty vector if there are no term AssociationType. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getTermAssociationTypes

public java.util.Vector getTermAssociationTypes()

Retrieves all term association types.

Returns:

a vector of all the term AssociationTypes. Returns an empty vector if there are no term AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getTermAssociationTypes

public java.util.Vector getTermAssociationTypes(int namespaceId)

Retrieves all term association types in a given namespace.

Parameters:

namespaceId - namespace id

Returns:

a vector of all the term AssociationTypes. Returns an empty vector if there are no term AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getAllSynonymTypes

public java.util.Vector getAllSynonymTypes()

Retrieves all synonym types.

Returns:

a vector of all the synonym AssociationTypes. Returns an empty vector if there are no synonym AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getSynonymTypes

public java.util.Vector getSynonymTypes()

Retrieves all synonym types.

Returns:

a vector of all the synonym AssociationTypes. Returns an empty vector if there are no synonym AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getSynonymTypes

public java.util.Vector getSynonymTypes(int namespaceId)

Retrieves all synonym types in a given namespace.

Parameters:

namespaceId - namespace id

Returns:

a vector of all the synonym AssociationTypes. Returns an empty vector if there are no synonym AssociationTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

findConceptsById

public java.util.Vector findConceptsById(java.util.Vector conceptIds_in)

Finds concept names matched with specified concept ids.

Parameters:

conceptIds_in - a vector of concept ids

Returns:

a vector of concept names

Since:

DTSRPC 2.0

findConceptsById

public java.util.Vector findConceptsById(java.util.Vector conceptIds_in,
                                         java.util.Vector namespaceIds_in)

Finds concept names matched with specified concept ids.

Parameters:

conceptIds_in - a vector of concept ids

namespaceIds_in - a vector of namespace ids

Returns:

a vector of concept names

Since:

DTSRPC 2.0

findConceptsByCode

public java.util.Vector findConceptsByCode(java.util.Vector conceptCodes_in)

Finds concept names matched with specified concept codes.

Parameters:

conceptCodes_in - a vector of concept codes

Returns:

a vector of concept names

Since:

DTSRPC 2.0

findConceptsByCode

public java.util.Vector findConceptsByCode(java.util.Vector conceptCodes_in,
                                           java.util.Vector namespaceIds_in)

Finds concept names matched with specified concept codes.

Parameters:

conceptCodes_in - a vector of concept codes

namespaceIds_in - a vector of namespace ids

Returns:

a vector of concept names

Since:

DTSRPC 2.0

getAllConceptPropertyTypes

public java.util.Vector getAllConceptPropertyTypes()

Retrieves all concept property types.

Returns:

a vector of all the concept DTSPropertyTypes. Returns an empty vector if there are no concept DTSPropertyType. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptPropertyTypes

public java.util.Vector getConceptPropertyTypes()

Retrieves all concept property types.

Returns:

a vector of all the concept DTSPropertyTypes. Returns an empty vector if there are no concept DTSPropertyTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptPropertyTypes

public java.util.Vector getConceptPropertyTypes(int namespaceId)

Retrieves all concept property types within a given namespace.

Parameters:

namespaceId - - the ID of the namespace of interest

Returns:

a vector of DTSPropertyTypes in the namespace. Returns an empty vector if there are no concept DTSPropertyType. Returns null, if there is an exception.

getAllTermPropertyTypes

public java.util.Vector getAllTermPropertyTypes()

Retrieves all term property types.

Returns:

a vector of all the term PropertyTypes. Returns an empty vector if there are no term PropertyTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getTermPropertyTypes

public java.util.Vector getTermPropertyTypes()

Retrieves all term property types within a given namespace.

Returns:

a vector of DTSPropertyTypes in the namespace. Returns an empty vector if there are no term DTSPropertyType. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getTermPropertyTypes

public java.util.Vector getTermPropertyTypes(int namespaceId)

Retrieves all term property types within a given namespace.

Parameters:

namespaceId - - the ID of the namespace of interest

Returns:

a vector of DTSPropertyTypes in the namespace. Returns an empty vector if there are no term DTSPropertyTypes. Returns null, if there is an exception.

Since:

DTSRPC 2.0

ping

public java.lang.String ping(boolean db)

ping DTS Server .

Parameters:

db - if true, return date from db

Returns:

XML formatted string which shows the result of ping.

Since:

DTSRPC 2.0

getHistoryDates

public java.util.Vector getHistoryDates()

Gets all distinct dates in concept_history table.

Returns:

a vector of Date All distinct dates in concept_history table. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getHistoryRecords

public java.util.Vector getHistoryRecords(java.lang.String vocabularyName,
                                          java.lang.String conceptcode)

Retrieves a set of history records from the concept_history table.

Parameters:

vocabularyName - vocabulary name

conceptcode - concept code

Returns:

a vector of HistoryRecord instances. Returns null, if there is an exception.

Since:

DTSRPC 2.1

getHistoryRecords

public java.util.Vector getHistoryRecords(java.lang.String vocabularyName,
                                          java.util.Date iBaselineDate_in,
                                          java.util.Date fBaselineDate_in)

Retrieves a set of history records from the concept_history table.

Parameters:

vocabularyName - vocabulary name

iBaselineDate_in - initial baseline date

fBaselineDate_in - final baseline date

Returns:

a vector of HistoryRecord instances. Returns null, if there is an exception.

Since:

DTSRPC 2.1

getHistoryRecords

public java.util.Vector getHistoryRecords(java.lang.String vocabularyName,
                                          java.util.Date iBaselineDate_in,
                                          java.util.Date fBaselineDate_in,
                                          java.lang.String conceptcode)

Retrieves a set of history records from the concept_history table.

Parameters:

vocabularyName - vocabulary name

iBaselineDate_in - initial baseline date

fBaselineDate_in - final baseline date

conceptcode - concept code

Returns:

a vector of HistoryRecord instances. Returns null, if there is an exception.

Since:

DTSRPC 2.1

getHistoryStart

public java.util.Date getHistoryStart()

Gets the initial date in concept_history table.

Returns:

Date The initial date in the concept_history table. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getHistoryEnd

public java.util.Date getHistoryEnd()

Gets the latest date in concept_history table.

Returns:

Date The latest date in the concept_history table. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptCreationDate

public java.util.Date getConceptCreationDate(java.lang.String inCode)

Gets the baseline date of creation of the specified concept.

Parameters:

inCode - - The specified concept's code.

Returns:

Date The baseline date of creation of inCode from either "Create" or "Split" edit action. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptCreationDate

public java.util.Date getConceptCreationDate(int namespaceId,
                                             java.lang.String inCode)

Gets the baseline date of creation of the specified concept.

Parameters:

namespaceId - - The namespace id of the concept

inCode - The specified concept's code.

Returns:

Date The baseline date of creation of inCode from either "Create" or "Split" edit action. Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDescendantCodes

public java.util.Vector getDescendantCodes(java.lang.String inCode,
                                           boolean atBaseline,
                                           java.util.Date iBaselineDate_in,
                                           java.util.Date fBaselineDate_in)

Gets the descendant concept codes of the specified concept. The search extends to a final baseline date starting from an initial baseline date. The search is based on a boolean value. If the value is true, the method only searches for the active concepts at the final baseline date. If the value is false, the method searches for all descendant concepts, whether active or retired. The search is only applied to "split/merge" actions and the specified concept could be the descendant concept of itself.

Parameters:

inCode - The specified concept's code.

atBaseline - The boolean value to specify the search type.

iBaselineDate_in - initial baseline date

fBaselineDate_in - final baseline date

Returns:

a vector of String The returned concept codes which are the descendant concepts of inCode. Returns null, if there is an exception.

getDescendantCodes

public java.util.Vector getDescendantCodes(int namespaceId,
                                           java.lang.String inCode,
                                           boolean atBaseline,
                                           java.util.Date iBaselineDate_in,
                                           java.util.Date fBaselineDate_in)

Gets the descendant concept codes of the specified concept. The search extends to a final baseline date starting from an initial baseline date. The search is based on a boolean value. If the value is true, the method only searches for the active concepts at the final baseline date. If the value is false, the method searches for all descendant concepts, whether active or retired. The search is only applied to "split/merge" actions and the specified concept could be the descendant concept of itself.

Parameters:

namespaceId - The namespace id of the concept

inCode - The specified concept's code.

atBaseline - The boolean value to specify the search type.

iBaselineDate_in - initial baseline date

fBaselineDate_in - final baseline date

Returns:

a vector of String The returned concept codes which are the descendant concepts of inCode. Returns null, if there is an exception.

getCodeActionChildren

public java.util.Vector getCodeActionChildren(java.lang.String inCode,
                                              java.util.Date baselineDate_in)

Gets the descendant concepts' codes of the specified concept involved in "split or merge" actions that occurred in the specified baseline date. The specified concept is included if it's not retired in the specified baseline date.

Parameters:

inCode - - The specified concept's code.

baselineDate_in - baseline date

Returns:

a vector of String The returned concept codes are the descendant concepts of inCode which are involved in "split or merge" actions that occurred in baselineDate. Returns null, if there is an exception.

getCodeActionChildren

public java.util.Vector getCodeActionChildren(int namespaceId,
                                              java.lang.String inCode,
                                              java.util.Date baselineDate_in)

Gets the descendant concepts' codes of the specified concept involved in "split or merge" actions that occurred in the specified baseline date. The specified concept is included if it's not retired in the specified baseline date.

Parameters:

namespaceId - - The namespace id of the concept

inCode - - The specified concept's code.

baselineDate_in - baseline date

Returns:

a vector of String The returned concept codes are the descendant concepts of inCode which are involved in "split or merge" actions that occurred in baselineDate. Returns null, if there is an exception.

getDescendantCodeActionDates

public java.util.Vector getDescendantCodeActionDates(java.lang.String inCode,
                                                     java.util.Date iBaselineDate_in,
                                                     java.util.Date fBaselineDate_in)

Gets the descendant concepts' CodeActionDate of the specified concept. A CodeActionDate contains a concept code and a baseline date. The method searches for all descendant concepts of the specified concept, whether active or retired. The search is only applied to the "split/merge" actions and the specified concept could be the descendant concept of itself.

Parameters:

inCode - - The specified concept's code.

iBaselineDate_in - initial baseline date

fBaselineDate_in - final baseline date

Returns:

a vector of Strings containing CodeActionDate data The returned vector contains the descendant concepts of inCode and the correspond baseline dates. Returns null, if there is an exception.

getDescendantCodeActionDates

public java.util.Vector getDescendantCodeActionDates(int namespaceId,
                                                     java.lang.String inCode,
                                                     java.util.Date iBaselineDate_in,
                                                     java.util.Date fBaselineDate_in)

Gets the descendant concepts' CodeActionDate of the specified concept. A CodeActionDate contains a concept code and a baseline date. The method searches for all descendant concepts of the specified concept, whether active or retired. The search is only applied to the "split/merge" actions and the specified concept could be the descendant concept of itself.

Parameters:

namespaceId - namespace id

inCode - - The specified concept's code.

iBaselineDate_in - initial baseline date

fBaselineDate_in - final baseline date

Returns:

a vector of Strings containing CodeActionDate data The returned vector contains the descendant concepts of inCode and the correspond baseline dates. Returns null, if there is an exception.

getAncestorCodes

public java.util.Vector getAncestorCodes(java.lang.String inCode,
                                         boolean atBaseline,
                                         java.util.Date iBaselineDate_in,
                                         java.util.Date fBaselineDate_in)

Gets the ancestor concept codes of the specified concept. The search extends to a final baseline date starting from an initial baseline date. The search is based on a boolean value. If the value is true, the method only searches for the active concepts at the initial baseline date. If the value is false, the method searches for all ancestor concepts, whether active or retired. The search is only applied to "split/merge" actions and the specified concept could be the ancestor concept of itself.

Parameters:

inCode - - The specified concept's code.

atBaseline - - The boolean value to specify the search type.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

a vector of String The returned concept codes which are the ancestor concepts of inCode. Returns null, if there is an exception.

getAncestorCodes

public java.util.Vector getAncestorCodes(int namespaceId,
                                         java.lang.String inCode,
                                         boolean atBaseline,
                                         java.util.Date iBaselineDate_in,
                                         java.util.Date fBaselineDate_in)

Gets the ancestor concept codes of the specified concept. The search extends to a final baseline date starting from an initial baseline date. The search is based on a boolean value. If the value is true, the method only searches for the active concepts at the initial baseline date. If the value is false, the method searches for all ancestor concepts, whether active or retired. The search is only applied to "split/merge" actions and the specified concept could be the ancestor concept of itself.

Parameters:

namespaceId - - The namespace id of the concept

inCode - - The specified concept's code.

atBaseline - - The boolean value to specify the search type.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

a vector of String The returned concept codes which are the ancestor concepts of inCode. Returns null, if there is an exception.

getCodeActionParents

public java.util.Vector getCodeActionParents(java.lang.String inCode,
                                             java.util.Date baselineDate_in)

Gets the ancestor concepts' codes of the specified concept involved in "split or merge" actions that occurred in the specified baseline date. The specified concept is included if it's an ancestor of itself.

Parameters:

inCode - - The specified concept's code.

baselineDate_in - - The specified baseline date.

Returns:

a vector of String The returned concept codes are the ancestor concepts of inCode which are involved in "split or merge" actions that occurred in baselineDate. Returns null, if there is an exception.

getCodeActionParents

public java.util.Vector getCodeActionParents(int namespaceId,
                                             java.lang.String inCode,
                                             java.util.Date baselineDate_in)

Gets the ancestor concepts' codes of the specified concept involved in "split or merge" actions that occurred in the specified baseline date. The specified concept is included if it's an ancestor of itself.

Parameters:

namespaceId - - The namespace id of the concept

inCode - - The specified concept's code.

baselineDate_in - - The specified baseline date.

Returns:

a vector of String The returned concept codes are the ancestor concepts of inCode which are involved in "split or merge" actions that occurred in baselineDate. Returns null, if there is an exception.

getAncestorCodeActionDates

public java.util.Vector getAncestorCodeActionDates(java.lang.String inCode,
                                                   java.util.Date iBaselineDate_in,
                                                   java.util.Date fBaselineDate_in)

Gets the ancestor concepts' CodeActionDate of the specified concept. A CodeActionDate contains a concept code and a baseline date. The method searches for all ancestor concepts of the specified concept, whether active or retired. The search is only applied to "split/merge" actions and the specified concept could be the ancestor concept of itself.

Parameters:

inCode - - The specified concept's code.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

a vector of Strings containing CodeActionDate data The returned String contains the ancestor concepts of inCode and the correspond baseline dates. Returns null, if there is an exception.

getAncestorCodeActionDates

public java.util.Vector getAncestorCodeActionDates(int namespaceId,
                                                   java.lang.String inCode,
                                                   java.util.Date iBaselineDate_in,
                                                   java.util.Date fBaselineDate_in)

Gets the ancestor concepts' CodeActionDate of the specified concept. A CodeActionDate contains a concept code and a baseline date. The method searches for all ancestor concepts of the specified concept, whether active or retired. The search is only applied to "split/merge" actions and the specified concept could be the ancestor concept of itself.

Parameters:

namespaceId - - namespace id

inCode - - The specified concept's code.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

a vector of Strings containing CodeActionDate data The returned String contains the ancestor concepts of inCode and the correspond baseline dates. Returns null, if there is an exception.

getConceptEditAction

public java.util.Vector getConceptEditAction(java.lang.String inCode)

Gets all EditAction of the specified concept. A EditAction contains a edit date and an editing action. The method searches for all editing actions and the corresponding editing dates on the specified concept.

Parameters:

inCode - - The specified concept's code.

Returns:

a vector of String The returned Strings contain all editing actions and the corresponding editing dates on inCode. Returns null, if there is an exception.

getConceptEditAction

public java.util.Vector getConceptEditAction(int namespaceId,
                                             java.lang.String inCode)

Gets all EditAction of the specified concept. A EditAction contains a edit date and an editing action. The method searches for all editing actions and the corresponding editing dates on the specified concept.

Parameters:

namespaceId - - namespace id

inCode - - The specified concept's code.

Returns:

a vector of String The returned Strings contain all editing actions and the corresponding editing dates on inCode. Returns null, if there is an exception.

isConceptRetired

public boolean isConceptRetired(java.lang.String inCode)

Deprecated. replaced by isRetired(java.lang.String) since DTSRPC 1.3.1

Checks if the specified concept is retired or not.

Parameters:

inCode - - The specified concept's code.

Returns:

a boolean True - inCode is retired. False - inCode is active. Returns null, if there is an exception.

isConceptRetired

public boolean isConceptRetired(int namespaceId,
                                java.lang.String inCode)

Deprecated. replaced by isRetired(java.lang.String) since DTSRPC 1.3.1

Checks if the specified concept is retired or not.

Parameters:

namespaceId - - namespace id

inCode - - The specified concept's code.

Returns:

a boolean True - inCode is retired. False - inCode is active. Returns null, if there is an exception.

isRetired

public java.lang.Boolean isRetired(java.lang.String inCode)

Checks if the specified concept is retired or not.

Parameters:

inCode - - The specified concept's code.

Returns:

a Boolean True - inCode is retired. False - inCode is active. Returns null, if there is an exception.

isRetired

public java.lang.Boolean isRetired(int namespaceId,
                                   java.lang.String inCode)

Checks if the specified concept is retired or not.

Parameters:

namespaceId - - namespace id

inCode - - The specified concept's code.

Returns:

a Boolean True - inCode is retired. False - inCode is active. Returns null, if there is an exception.

isConceptEdited

public boolean isConceptEdited(java.lang.String inCode,
                               boolean mrg_splt,
                               java.util.Date iBaselineDate_in,
                               java.util.Date fBaselineDate_in)

Checks if the specified concept is edited or not during a date range. The check is depended on a boolean value. If the boolean value is true, the method only checks if the specified concept was merged or split in the date range. If the boolean value is false, the method checks if the specified concept was edited in any way in the date range.

Parameters:

inCode - - The specified concept's code.

mrg_splt - - True - only check for "merge or split" editing action. False - check for any editing action.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

a boolean True - inCode is edited. False - inCode isn't edited. Returns null, if there is an exception.

isConceptEdited

public boolean isConceptEdited(int namespaceId,
                               java.lang.String inCode,
                               boolean mrg_splt,
                               java.util.Date iBaselineDate_in,
                               java.util.Date fBaselineDate_in)

Checks if the specified concept is edited or not during a date range. The check is depended on a boolean value. If the boolean value is true, the method only checks if the specified concept was merged or split in the date range. If the boolean value is false, the method checks if the specified concept was edited in any way in the date range.

Parameters:

namespaceId - - namespace id

inCode - - The specified concept's code.

mrg_splt - - True - only check for "merge or split" editing action. False - check for any editing action.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

a boolean True - inCode is edited. False - inCode isn't edited. Returns null, if there is an exception.

isEdited

public java.lang.Boolean isEdited(java.lang.String inCode,
                                  boolean mrg_splt,
                                  java.util.Date iBaselineDate_in,
                                  java.util.Date fBaselineDate_in)

Checks if the specified concept is edited or not during a date range. The check is depended on a boolean value. If the boolean value is true, the method only checks if the specified concept was merged or split in the date range. If the boolean value is false, the method checks if the specified concept was edited in any way in the date range.

Parameters:

inCode - - The specified concept's code.

mrg_splt - - True - only check for "merge or split" editing action. False - check for any editing action.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

a boolean True - inCode is edited. False - inCode isn't edited. Returns null, if there is an exception.

isEdited

public java.lang.Boolean isEdited(int namespaceId,
                                  java.lang.String inCode,
                                  boolean mrg_splt,
                                  java.util.Date iBaselineDate_in,
                                  java.util.Date fBaselineDate_in)

Checks if the specified concept is edited or not during a date range. The check is depended on a boolean value. If the boolean value is true, the method only checks if the specified concept was merged or split in the date range. If the boolean value is false, the method checks if the specified concept was edited in any way in the date range.

Parameters:

namespaceId - - namespace id

inCode - - The specified concept's code.

mrg_splt - - True - only check for "merge or split" editing action. False - check for any editing action.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

a boolean True - inCode is edited. False - inCode isn't edited. Returns null, if there is an exception.

getNumberEditActions

public int getNumberEditActions(java.lang.String inCode,
                                java.util.Date baselineDate_in)

Gets the number of editing actions on the specified concept registered in the specified baseline date.

Parameters:

inCode - - The specified concept's code.

baselineDate_in - - The specified baseline date.

Returns:

an int The number of editing actions on inCode registered in baselineDate. Returns null, if there is an exception.

getNumberEditActions

public int getNumberEditActions(int namespaceId,
                                java.lang.String inCode,
                                java.util.Date baselineDate_in)

Gets the number of editing actions on the specified concept registered in the specified baseline date.

Parameters:

namespaceId - The namespace of the concept

inCode - The specified concept's code.

baselineDate_in - The baseline date

Returns:

an int The number of editing actions on inCode registered in baselineDate. Returns null, if there is an exception.

getNumberEditActions

public int getNumberEditActions(java.lang.String inCode,
                                java.util.Date iBaselineDate_in,
                                java.util.Date fBaselineDate_in)

Gets the number of editing actions on the specified concept registered in the specified baseline date.

Parameters:

inCode - - The specified concept's code.

iBaselineDate_in - - initial baseline date

fBaselineDate_in - - final baseline date

Returns:

an int The number of editing actions on inCode registered in baselineDate. Returns null, if there is an exception.

getNumberEditActions

public int getNumberEditActions(int namespaceId,
                                java.lang.String inCode,
                                java.util.Date iBaselineDate_in,
                                java.util.Date fBaselineDate_in)

Gets the number of editing actions on the specified concept registered in the specified baseline date.

Parameters:

namespaceId - - namespace id

inCode - - The specified concept's code.

iBaselineDate_in - - The initial baseline date.

fBaselineDate_in - - The final baseline date.

Returns:

an int The number of editing actions on inCode registered in baselineDate. Returns null, if there is an exception.

getConceptEditAction

public java.util.Vector getConceptEditAction(java.lang.String inCode,
                                             java.util.Date baselineDate_in)

Gets all EditAction of the specified concept. A EditAction contains a edit date and an editing action. The method searches for all editing actions and the corresponding editing dates on the specified concept.

Parameters:

inCode - - The specified concept's code.

baselineDate_in - baseline date

Returns:

a vector of Strings The returned Strings contain all editing actions and the corresponding editing dates on inCode. Returns null, if there is an exception.

getConceptEditAction

public java.util.Vector getConceptEditAction(int namespaceId,
                                             java.lang.String inCode,
                                             java.util.Date baselineDate_in)

Gets all EditAction of the specified concept. A EditAction contains a edit date and an editing action. The method searches for all editing actions and the corresponding editing dates on the specified concept.

Parameters:

namespaceId - - namespace id

inCode - - The specified concept's code.

baselineDate_in - baseline date

Returns:

a vector of Strings The returned Strings contain all editing actions and the corresponding editing dates on inCode. Returns null, if there is an exception.

getLicense

public java.lang.String getLicense(java.lang.String source)

Gets the license for a given source.

Parameters:

source - - the source for which the license is to be retreived

Returns:

String the string describing the license text Returns null, if there is an exception.

getAllLicenses

public java.util.Vector getAllLicenses(java.lang.String condition)

Gets all licenses from the server. If no condition exists, then pass in a empty String.

Parameters:

condition - the value of a condition parameter

Returns:

Vector a vector of Strings describing the licenses Returns null, if there is an exception.

findConceptsWithSiloMatching

public java.util.Vector findConceptsWithSiloMatching(java.lang.String pattern,
                                                     int limit)

Gets a vector of silo names that represent the search pattern, but with those attributes present that are specified in the AttributteSetDescriptor.

Parameters:

pattern - - the query string (pattern) on which the search is based

limit - the maximum number of matches to be returned

Returns:

a vector of concepts that contain the search string pattern Returns null, if there is an exception.

findConceptsWithSiloMatching

public java.util.Vector findConceptsWithSiloMatching(java.lang.String pattern,
                                                     int limit,
                                                     java.lang.String siloname)

Gets a vector of silo names that represent the search pattern, but with those attributes present that are specified in the AttributteSetDescriptor.

Parameters:

pattern - - the query string (pattern) on which the search is based

limit - the maximum number of matches to be returned

siloname - the name of Silo where the search will be performed

Returns:

a vector of concepts that contain the search string pattern Returns null, if there is an exception.

findConceptsWithSiloMatching

public Concept[] findConceptsWithSiloMatching(java.lang.String pattern,
                                              int limit,
                                              int ASD_index,
                                              boolean bestMatchOnly,
                                              boolean spellCorrection,
                                              boolean closeResult,
                                              int matchtype_index,
                                              java.lang.String siloname)

Gets an array of Concept objects that represents the search pattern since DTSRPC 2.1

Parameters:

pattern - - the query string (pattern) on which the search is based

limit - the maximum number of matches to be returned

ASD_index - concept attribute set descriptor index

bestMatchOnly - indicator variable true if best match only; false, otherwise

spellCorrection - indicator variable true if spell checking is used, false, otherwise

closeResult - indicator variable true if shortest match rule is applied, false, otherwise

matchtype_index - 1: complete match; 2: partial under match; 3: under match

siloname - silo name

Returns:

an array of Concept objects that match with search criteria as specified by the input parameters Returns null, if there is an exception.

searchSilo

public java.util.Vector searchSilo(java.lang.String pattern,
                                   int limit)

Searches for the specified pattern using the given search specification and returns an array of matches.

Parameters:

pattern - - the words to search for

limit - the maximum number of matches to be returned

Returns:

a vector of matched strings that matched the search words Returns null, if there is an exception.

findNamespaceById

public java.lang.String findNamespaceById(int namespaceId)

Finds the namespace that matched with a specified id

Parameters:

namespaceId - - the namespace ID

Returns:

a namespace name corresponding to the specified namespace ID Returns null, if there is an exception.

Since:

DTSRPC 2.0

findNamespaceByCode

public java.lang.String findNamespaceByCode(java.lang.String namespaceCode)

Finds the namespace that matched with a specified id

Parameters:

namespaceCode - - the namespace code

Returns:

a namespace name corresponding to the specified namespace Code Returns null, if there is an exception.

getVersions

public java.util.Vector getVersions()

Retrieves an array of ContentVersions which are the list of versions

Returns:

the ContentVersions of the given namespace Returns null, if there is an exception.

getVersions

public java.util.Vector getVersions(int namespaceId)

Retrieves an array of ContentVersions which are the list of versions for the given namespace Id in the knowledgebase.

Parameters:

namespaceId - - the namespace ID

Returns:

the ContentVersions of the given namespace Returns null, if there is an exception.

getAuthorities

public java.util.Vector getAuthorities()

Retrieves a vector of Authority names which represent the available namespace authorities in the DTS knowledgebase.

Returns:

the available namespace authorities Returns null, if there is an exception.

hasPermission

public java.lang.Boolean hasPermission()

Determine whether the currently logged on user has permission to write to the default namespace. This is only effective if the application connects to the server using a secure socket connection.

Returns:

true if using a secure socket connection and the currently logged on user has permission to write to this namespace, or if using any other type of server connection; otherwise false Returns null, if there is an exception.

hasPermission

public java.lang.Boolean hasPermission(int namespaceId)

Determine whether the currently logged on user has permission to write to the specified namespace. This is only effective if the application connects to the server using a secure socket connection.

Parameters:

namespaceId - - the ID of the namespace to check for permission

Returns:

true if using a secure socket connection and the currently logged on user has permission to write to this namespace, or if using any other type of server connection; otherwise false Returns null, if there is an exception.

getConceptChildRoots

public java.util.Vector getConceptChildRoots()

Gets the names of root concepts

Returns:

vector of root concept names Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptChildRoots

public java.util.Vector getConceptChildRoots(int namespaceId)

Get root concept names

Parameters:

namespaceId - namespace id

Returns:

root concept names

Since:

DTSRPC 2.0

isSubConceptById

public java.lang.Boolean isSubConceptById(int conceptId1,
                                          int conceptId2)

Checks if the concept with id conceptId1 is a subconcept of the concept with id conceptI2

Parameters:

conceptId1 - a concept ID

conceptId2 - a concept ID

Returns:

true, if the concept with id conceptId1 is a subconcept of the concept with id conceptI2; false, otherwise

Since:

DTSRPC 2.0

isSubConceptById

public java.lang.Boolean isSubConceptById(int conceptId1,
                                          int conceptId2,
                                          int namespaceId)

Checks if the concept with id conceptId1 is a subconcept of the concept with id conceptI2

Parameters:

conceptId1 - a concept ID

conceptId2 - a concept ID

namespaceId - namespace id

Returns:

true, if the concept with id conceptId1 is a subconcept of the concept with id conceptI2; false, otherwise

Since:

DTSRPC 2.0

getFetchedRoles

public java.util.Vector getFetchedRoles(java.lang.String ontylogconcept_in)

Gets the roles which have been retrieved for this concept.

Parameters:

ontylogconcept_in - the name of an ontylog concept

Returns:

fetched role

Since:

DTSRPC 2.0

getFetchedRoles

public java.util.Vector getFetchedRoles(java.lang.String ontylogconcept_in,
                                        int namespaceId)

Gets the roles which have been retrieved for this concept.

Parameters:

ontylogconcept_in - the name of an ontylog concept

namespaceId - namespace id

Returns:

a vector of the roles Returns null, if there is an exception.

getNumberOfSpecifiedRoles

public int getNumberOfSpecifiedRoles(java.lang.String ontylogconcept_in)

Gets the number of roles that are available of the types specified in the ConceptAttributeSetDescriptor used to obtain this OntylogConcept.

Parameters:

ontylogconcept_in - the name of an ontylog concept

Returns:

number of roles of the specified types Returns null, if there is an exception.

getNumberOfSpecifiedRoles

public int getNumberOfSpecifiedRoles(java.lang.String ontylogconcept_in,
                                     int namespaceId)

Gets the number of roles that are available of the types specified in the ConceptAttributeSetDescriptor used to obtain this OntylogConcept.

Parameters:

ontylogconcept_in - the name of an ontylog concept

namespaceId - namespace id

Returns:

number of roles of the specified types Returns null, if there is an exception.

getFetchedInverseRoles

public java.util.Vector getFetchedInverseRoles(java.lang.String ontylogconcept_in)

Gets the fetched inverse roles of a given concept. (i.e., roles having this concept as a value)

Parameters:

ontylogconcept_in - concept name

Returns:

a vector of the inverse roles Returns null, if there is an exception.

getFetchedInverseRoles

public java.util.Vector getFetchedInverseRoles(java.lang.String ontylogconcept_in,
                                               int namespaceId)

Gets the fetched inverse roles of a given concept. (i.e., roles having this concept as a value)

Parameters:

ontylogconcept_in - concept name

Returns:

a vector of the inverse roles Returns null, if there is an exception.

getNumberOfSpecifiedInverseRoles

public int getNumberOfSpecifiedInverseRoles(java.lang.String ontylogconcept_in)

Get the number of inverse roles that are available of the types specified in the ConceptAttributeSetDescriptor used to obtain this OntylogConcept.

Parameters:

ontylogconcept_in - the name of an ontylog concept

Returns:

number of inverse roles of the specified types Returns null, if there is an exception.

getNumberOfSpecifiedInverseRoles

public int getNumberOfSpecifiedInverseRoles(java.lang.String ontylogconcept_in,
                                            int namespaceId)

Gets the number of inverse roles that are available of the types specified in the ConceptAttributeSetDescriptor used to obtain this OntylogConcept.

Parameters:

ontylogconcept_in - the name of an ontylog concept

namespaceId - namespace id

Returns:

number of inverse roles of the specified types Returns null, if there is an exception.

getFetchedHasSubs

public java.lang.Boolean getFetchedHasSubs(java.lang.String ontylogconcept_in)

Checks if the concept has subconcepts.

Parameters:

ontylogconcept_in - the name of an ontylog concept

Returns:

If the concept has subconcepts, return true. Otherwise, return false. Returns null, if there is an exception.

getFetchedHasSubs

public java.lang.Boolean getFetchedHasSubs(java.lang.String ontylogconcept_in,
                                           int namespaceId)

Checks if the concept has subconcepts.

Parameters:

ontylogconcept_in - the name of an ontylog concept

namespaceId - namespace id

Returns:

If the concept has subconcepts, return true. Otherwise, return false. Returns null, if there is an exception.

getFetchedHasSups

public java.lang.Boolean getFetchedHasSups(java.lang.String ontylogconcept_in)

Checks if the concept has superconcepts.

Parameters:

ontylogconcept_in - the name of an ontylog concept

Returns:

If the concept has superconcepts, return true. Otherwise, return false. Returns null, if there is an exception.

getFetchedHasSups

public java.lang.Boolean getFetchedHasSups(java.lang.String ontylogconcept_in,
                                           int namespaceId)

Checks if the concept has superconcepts.

Parameters:

ontylogconcept_in - the name of an ontylog concept

namespaceId - namespace id

Returns:

If the concept has superconcepts, return Boolean.TRUE. Otherwise, return Boolean.FALSE. Returns null, if there is an exception.

getAllQualifierTypes

public java.util.Vector getAllQualifierTypes()

Retrieves all qualifier type names.

Returns:

a vector of all the QualifierType names. Returns an empty vector if there are no QualifierTypes. Returns null, if there is an exception.

getAllConceptPropertyQualifierTypes

public java.util.Vector getAllConceptPropertyQualifierTypes()

Retrieves all concept property qualifier type names.

Returns:

a vector of all the concept property qualifier type names. Returns an empty vector if there are no concept property QualifierTypes. Returns null, if there is an exception.

getConceptPropertyQualifierTypes

public java.util.Vector getConceptPropertyQualifierTypes()

Retrieves all concept property qualifier types.

Returns:

a vector of concept property QualifierType names. Returns an empty vector if there are no concept property QualifierTypes. Returns null, if there is an exception.

getConceptPropertyQualifierTypes

public java.util.Vector getConceptPropertyQualifierTypes(int namespaceId)

Retrieves all concept property qualifier types within a given namespace.

Parameters:

namespaceId - - the ID of the namespace of interest

Returns:

a vector of concept property QualifierTypes in the namespace. Returns an empty vector if there are no concept property QualifierTypes. Returns null, if there is an exception.

getAllTermPropertyQualifierTypes

public java.util.Vector getAllTermPropertyQualifierTypes()

Retrieves all term property qualifier type names.

Returns:

all term property qualifier type names.

Since:

DTSRPC 2.0

getTermPropertyQualifierTypes

public java.util.Vector getTermPropertyQualifierTypes()

Retrieves the names of all term property qualifier types

Returns:

a vector of term property QualifierTypes in the namespace. Returns an empty vector if there are no term property QualifierTypes. Returns null, if there is an exception.

getTermPropertyQualifierTypes

public java.util.Vector getTermPropertyQualifierTypes(int namespaceId)

Retrieves the names of all term property qualifier types within a given namespace.

Parameters:

namespaceId - - the ID of the namespace of interest

Returns:

a vector of term property QualifierTypes in the namespace. Returns an empty vector if there are no term property QualifierTypes. Returns null, if there is an exception.

getAllConceptAssociationQualifierTypes

public java.util.Vector getAllConceptAssociationQualifierTypes()

Retrieves the names of all concept association qualifier types.

Returns:

a vector of all the concept association QualifierTypes. Returns an empty vector if there are no concept association QualifierTypes. Returns null, if there is an exception.

getConceptAssociationQualifierTypes

public java.util.Vector getConceptAssociationQualifierTypes()

Retrieves the names of all concept association qualifier types

Returns:

a vector of concept association QualifierTypes in the namespace. Returns an empty vector if there are no concept association QualifierTypes. Returns null, if there is an exception.

getConceptAssociationQualifierTypes

public java.util.Vector getConceptAssociationQualifierTypes(int namespaceId)

Retrieves the names of all concept association qualifier types within a given namespace.

Parameters:

namespaceId - - the ID of the namespace of interest

Returns:

a vector of concept association QualifierTypes in the namespace. Returns an empty vector if there are no concept association QualifierTypes. Returns null, if there is an exception.

getAllTermAssociationQualifierTypes

public java.util.Vector getAllTermAssociationQualifierTypes()

Retrieves all term association qualifier type names.

Returns:

a vector containing all term association qualifier type names

Since:

DTSRPC 2.0

getTermAssociationQualifierTypes

public java.util.Vector getTermAssociationQualifierTypes()

Retrieves all term association qualifier type names.

Returns:

a vector of all the term association QualifierType names. Returns an empty vector if there are no term association QualifierTypes. Returns null, if there is an exception.

getTermAssociationQualifierTypes

public java.util.Vector getTermAssociationQualifierTypes(int namespaceId)

Retrieves all term association qualifier type names within a specific namespace.

Parameters:

namespaceId - - the ID of the namespace of interest

Returns:

a vector of all the term association QualifierType names. Returns an empty vector if there are no term association QualifierType. Returns null, if there is an exception.

findConceptsWithNameMatching

public java.util.Vector findConceptsWithNameMatching(java.lang.String pattern,
                                                     int searchLimit)

Finds concepts with name matching a specific search criteria.

Parameters:

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithNameMatching

public java.util.Vector findConceptsWithNameMatching(java.lang.String pattern,
                                                     int searchLimit,
                                                     int namespaceId)

Finds concepts with name matching a specific search criteria.

Parameters:

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithNameMatching

public java.util.Vector findConceptsWithNameMatching(java.lang.String pattern,
                                                     int searchLimit,
                                                     boolean synonyms)

Finds concepts with name matching a specific search criteria.

Parameters:

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

synonyms - if true searches by synonym name and concept name.

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithNameMatching

public java.util.Vector findConceptsWithNameMatching(java.lang.String pattern,
                                                     int searchLimit,
                                                     boolean synonyms,
                                                     int namespaceId)

Finds concepts with name matching a specific search criteria.

Parameters:

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

synonyms - if true searches by synonym name and concept name.

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithPropertyMatching

public java.util.Vector findConceptsWithPropertyMatching(java.lang.String propType_in,
                                                         java.lang.String pattern,
                                                         int searchLimit)

Finds concepts with a property matching a specific search criteria.

Parameters:

propType_in - the name of a property type

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithPropertyMatching

public java.util.Vector findConceptsWithPropertyMatching(java.lang.String propType_in,
                                                         java.lang.String pattern,
                                                         int searchLimit,
                                                         int namespaceId)

Finds concepts with a property matching a specific search criteria.

Parameters:

propType_in - the name of a property type

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithPropertyContaining

public java.util.Vector findConceptsWithPropertyContaining(java.lang.String propType_in,
                                                           java.lang.String pattern,
                                                           int searchLimit)

Finds concepts with a property containing a specific search criteria.

Parameters:

propType_in - the name of a property type

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithPropertyContaining

public java.util.Vector findConceptsWithPropertyContaining(java.lang.String propType_in,
                                                           java.lang.String pattern,
                                                           int searchLimit,
                                                           int namespaceId)

Finds concepts with a property containing a specific search criteria.

Parameters:

propType_in - the name of a property type

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithRoleMatching

public java.util.Vector findConceptsWithRoleMatching(java.lang.String roleType_in,
                                                     java.lang.String pattern,
                                                     int searchLimit)

Finds concepts with a role matching a specific search criteria.

Parameters:

roleType_in - the name of a role type

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithRoleMatching

public java.util.Vector findConceptsWithRoleMatching(java.lang.String roleType_in,
                                                     java.lang.String pattern,
                                                     int searchLimit,
                                                     int namespaceId)

Finds concepts with a role matching a specific search criteria.

Parameters:

roleType_in - the name of a role type

pattern - the query string on which the search is based

searchLimit - the maximum number of matches

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithInverseRoleMatching

public java.util.Vector findConceptsWithInverseRoleMatching(java.lang.String roleType_in,
                                                            java.lang.String pattern,
                                                            int searchLimit)

Finds concepts with an inverse role matching a specific search criteria.

Parameters:

roleType_in - the name of a role type

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithInverseRoleMatching

public java.util.Vector findConceptsWithInverseRoleMatching(java.lang.String roleType_in,
                                                            java.lang.String pattern,
                                                            int searchLimit,
                                                            int namespaceId)

Finds concepts with an inverse role matching a specific search criteria.

Parameters:

roleType_in - the name of a role type

pattern - the query string (pattern) on which the search is based

searchLimit - the maximum number of matches

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithConceptAssociationMatching

public java.util.Vector findConceptsWithConceptAssociationMatching(java.lang.String conceptAssocType_in,
                                                                   java.lang.String toConceptName,
                                                                   int searchLimit)

Finds concepts with a concept association matching a specific search criteria.

Parameters:

conceptAssocType_in - concept association type to search for

toConceptName - the to concept name

searchLimit - the maximum number of matches

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithConceptAssociationMatching

public java.util.Vector findConceptsWithConceptAssociationMatching(java.lang.String conceptAssocType_in,
                                                                   java.lang.String toConceptName,
                                                                   int searchLimit,
                                                                   int namespaceId)

Finds concepts with a concept association matching a specific search criteria.

Parameters:

conceptAssocType_in - concept association type to search for

toConceptName - the to concept name

searchLimit - the maximum number of matches

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithInverseConceptAssociationMatching

public java.util.Vector findConceptsWithInverseConceptAssociationMatching(java.lang.String invConceptAssocType_in,
                                                                          java.lang.String fromConceptName,
                                                                          int searchLimit)

Finds concepts with an inverse concept association matching a specific search criteria.

Parameters:

invConceptAssocType_in - concept association type to search for

fromConceptName - the from concept name

searchLimit - the maximum number of matches

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithInverseConceptAssociationMatching

public java.util.Vector findConceptsWithInverseConceptAssociationMatching(java.lang.String invConceptAssocType_in,
                                                                          java.lang.String fromConceptName,
                                                                          int searchLimit,
                                                                          int namespaceId)

Finds concepts with an inverse concept association matching a specific search criteria.

Parameters:

invConceptAssocType_in - concept association type to search for

fromConceptName - the from concept name

searchLimit - the maximum number of matches

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithSynonymMatching

public java.util.Vector findConceptsWithSynonymMatching(java.lang.String synonymType_in,
                                                        java.lang.String synonymTermName,
                                                        int searchLimit)

Finds concepts with a synonym matching a specific search criteria.

Parameters:

synonymType_in - synonym type to search for

synonymTermName - the synonym name

searchLimit - the maximum number of matches

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

findConceptsWithSynonymMatching

public java.util.Vector findConceptsWithSynonymMatching(java.lang.String synonymType_in,
                                                        java.lang.String synonymTermName,
                                                        int searchLimit,
                                                        int namespaceId)

Finds concepts with a synonym matching a specific search criteria.

Parameters:

synonymType_in - synonym type to search for

synonymTermName - the synonym name

searchLimit - the maximum number of matches

namespaceId - namespace id

Returns:

a vector of names of concepts matching the specific search criteria

Since:

DTSRPC 2.0

getMatchString

public java.lang.String getMatchString(java.lang.String term_in)

Gets the string that was matched.

Parameters:

term_in - input term code

Returns:

the term name Returns null, if there is an exception.

getMatchString

public java.lang.String getMatchString(java.lang.String term_in,
                                       int namespaceId)

Gets the string that was matched.

Parameters:

term_in - input term code

namespaceId - namespace id

Returns:

the term name Returns null, if there is an exception.

getMatchItemType

public java.lang.String getMatchItemType(java.lang.String term_in)

Gets the match item type, i.e. "Synonymous Term"

Parameters:

term_in - input term code

Returns:

MatchItemType for term Returns null, if there is an exception.

getMatchItemType

public java.lang.String getMatchItemType(java.lang.String term_in,
                                         int namespaceId)

Gets the match item type, i.e. "Synonymous Term"

Parameters:

term_in - input term code

namespaceId - namespace id

Returns:

MatchItemType for term Returns null, if there is an exception.

getFetchedTermAssociations

public java.util.Vector getFetchedTermAssociations(java.lang.String term_in)

Gets the term associations which have been fetched for this term.

Parameters:

term_in - input term code

Returns:

the associations for this term Returns null, if there is an exception.

getFetchedTermAssociations

public java.util.Vector getFetchedTermAssociations(java.lang.String term_in,
                                                   int namespaceId)

Gets the term associations which have been fetched for this term.

Parameters:

term_in - input term code

namespaceId - namespace id

Returns:

the associations for this term Returns null, if there is an exception.

getNumberOfSpecifiedTermAssociations

public int getNumberOfSpecifiedTermAssociations(java.lang.String term_in)

Gets the number of term associations that are available for the specified term.

Parameters:

term_in - input term code

Returns:

number of term associations of the specified types Returns null, if there is an exception.

getNumberOfSpecifiedTermAssociations

public int getNumberOfSpecifiedTermAssociations(java.lang.String term_in,
                                                int namespaceId)

Gets the number of term associations that are available for the specified term.

Parameters:

term_in - input term code

namespaceId - namespace id

Returns:

number of term associations of the specified types Returns null, if there is an exception.

getFetchedInverseTermAssociations

public java.util.Vector getFetchedInverseTermAssociations(java.lang.String term_in)

Gets the inverse term associations which have been fetched for this term.

Parameters:

term_in - input term code

Returns:

the associations for this term Returns null, if there is an exception.

getFetchedInverseTermAssociations

public java.util.Vector getFetchedInverseTermAssociations(java.lang.String term_in,
                                                          int namespaceId)

Gets the inverse term associations which have been fetched for this term.

Parameters:

term_in - input term code

namespaceId - namespace id

Returns:

the associations for this term Returns null, if there is an exception.

getNumberOfSpecifiedInverseTermAssociations

public int getNumberOfSpecifiedInverseTermAssociations(java.lang.String term_in)

Gets the number of inverse term associations that are available for this term.

Parameters:

term_in - input term code

Returns:

number of inverse term associations of the specified types Returns null, if there is an exception.

getNumberOfSpecifiedInverseTermAssociations

public int getNumberOfSpecifiedInverseTermAssociations(java.lang.String term_in,
                                                       int namespaceId)

Get the number of inverse term associations that are available for this term.

Parameters:

term_in - input term code

namespaceId - namespace id

Returns:

number of inverse term associations of the specified types Returns null, if there is an exception.

findTermsWithNameMatching

public java.util.Vector findTermsWithNameMatching(java.lang.String pattern,
                                                  int searchLimit)

Retrieves each term with a name (string identifier) that matches the argument pattern, based on the specified search options.

Parameters:

pattern - - the term name pattern for searching

searchLimit - the maximum number of matches to be returned

Returns:

a vector of term names that match the search pattern. An empty vector is returned when there are no matches. Returns null, if there is an exception.

findTermsWithNameMatching

public java.util.Vector findTermsWithNameMatching(java.lang.String pattern,
                                                  int searchLimit,
                                                  int namespaceId)

Retrieves each term with a name (string identifier) that matches the argument pattern, based on the specified search options.

Parameters:

pattern - - the term name pattern for searching

searchLimit - the maximum number of matches to be returned

namespaceId - namespace id

Returns:

a vector of term names that match the search pattern. An empty vector is returned when there are no matches. Returns null, if there is an exception.

getConcepts

public Concept[] getConcepts(java.util.Vector conceptNames_in)

Retrieves Concepts with name matching with specified values

Parameters:

conceptNames_in - - a vector containing the specified concept names

Returns:

an array of Concept objects Returns null, if there is an exception.

getConcepts

public Concept[] getConcepts(java.util.Vector conceptNames_in,
                             boolean allAttributes)

Retrieves Concepts with name matching with specified values

Parameters:

conceptNames_in - - a vector containing the specified concept names

allAttributes - boolean variable indicating whether all attributes of matched concepts should also be retrieved

Returns:

an array of Concept objects Returns null, if there is an exception.

getConcepts

public Concept[] getConcepts(java.util.Vector conceptNames_in,
                             int ASD_index,
                             java.util.Vector namespaceIds_in)

Retrieves Concepts with name matching with specified values

Parameters:

conceptNames_in - - a vector containing the specified concept names

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceIds_in - - a vector containing the namespace ids of each corresponding concept

Returns:

an array of Concept objects Returns null, if there is an exception.

getAllPropertyTypes

public PropertyType[] getAllPropertyTypes()

Retrieves all PropertyType

Returns:

an array of PropertyType objects Returns null, if there is an exception.

getAllPropertyTypes

public PropertyType[] getAllPropertyTypes(int namespaceId)

Retrieves all PropertyType in a given namespace

Parameters:

namespaceId - - namespace id

Returns:

an array of PropertyType objects Returns null, if there is an exception.

getAllSilos

public Silo[] getAllSilos()

Retrieves all silos

Returns:

an array of Silo objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getAllRoleTypes

public RoleType[] getAllRoleTypes()

Retrieves all RoleType

Returns:

an array of RoleType objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getAllRoleTypesInNamespace

public RoleType[] getAllRoleTypesInNamespace()

Retrieves all RoleType in the default namespace

Returns:

an array of RoleType objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getAllRoleTypes

public RoleType[] getAllRoleTypes(int namespaceId)

Retrieves all RoleType in a given namespace

Parameters:

namespaceId - - namespace id

Returns:

an array of RoleType objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getRoleTypeById

public RoleType getRoleTypeById(int roleId)

Retrieves the RoleType corresponding to a specific RoleType identifier

Parameters:

roleId - - role id

Returns:

a RoleType object Returns null, if there is an exception.

Since:

DTSRPC 2.0

getRoleTypeById

public RoleType getRoleTypeById(int roleId,
                                int namespaceId)

Retrieves the RoleType corresponding to a specific RoleType identifier in a given namespace

Parameters:

roleId - role id

namespaceId - namespace id

Returns:

a RoleType object Returns null, if there is an exception.

getRoleTypeByName

public RoleType getRoleTypeByName(java.lang.String roleName)

Retrieves the RoleType corresponding to a specific RoleType name in the default namespace

Parameters:

roleName - role name

Returns:

a RoleType object Returns null, if there is an exception.

Since:

DTSRPC 2.0

getRoleTypeByName

public RoleType getRoleTypeByName(java.lang.String roleName,
                                  int namespaceId)

Retrieves the RoleType corresponding to a specific RoleType name in a given namespace

Parameters:

roleName - role name

namespaceId - namespace id

Returns:

a RoleType object Returns null, if there is an exception.

Since:

DTSRPC 2.0

getPropertyTypeById

public PropertyType getPropertyTypeById(int propertyId)

Retrieves the PropertyType corresponding to a specific PropertyType identifier in the default namespace

Parameters:

propertyId - property id

Returns:

a PropertyType object Returns null, if there is an exception.

Since:

DTSRPC 2.0

getPropertyTypeById

public PropertyType getPropertyTypeById(int propertyId,
                                        int namespaceId)

Retrieves the PropertyType corresponding to a specific PropertyType identifier in a specific namespace

Parameters:

propertyId - property id

namespaceId - - namespace id

Returns:

a PropertyType object Returns null, if there is an exception.

Since:

DTSRPC 2.0

getPropertyTypeByName

public PropertyType getPropertyTypeByName(java.lang.String propertyName)

Retrieves the PropertyType corresponding to a specific PropertyType name in the default namespace

Parameters:

propertyName - - property name

Returns:

a PropertyType object Returns null, if there is an exception.

Since:

DTSRPC 2.0

getPropertyTypeByName

public PropertyType getPropertyTypeByName(java.lang.String propertyName,
                                          int namespaceId)

Retrieves the PropertyType corresponding to a specific PropertyType name in a given namespace

Parameters:

propertyName - - property name

namespaceId - - namespace id

Returns:

a PropertyType object Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConcept

public Concept getConcept(java.lang.String inputvalue,
                          boolean inputcode,
                          int ASD_index,
                          int namespaceId)

Retrieves the Concept corresponding to a specific Concept name, or code in the default namespace with all fetched attributes

Parameters:

inputvalue - - Concept name, if inputcode is true; concept code, if otherwise

inputcode - - true, if inputvalue is a concept name, false, otherwise

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceId - - namespace Id

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.1

getConcept

public Concept getConcept(java.lang.String inputvalue,
                          boolean inputcode,
                          int ASD_index)

Retrieves the Concept corresponding to a specific Concept name, or code in the default namespace with all fetched attributes

Parameters:

inputvalue - - Concept name, if inputcode is true; concept code, if otherwise

inputcode - - true, if inputvalue is a concept name, false, otherwise

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.1

findConcept

public Concept findConcept(java.lang.String conceptname)

Retrieves the Concept corresponding to a specific Concept name in the default namespace with all fetched attributes

Parameters:

conceptname - - Concept name

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.0

findConcept

public Concept findConcept(java.lang.String conceptname,
                           boolean allAttributes)

Retrieves the Concept corresponding to a specific Concept name in the default namespace with all fetched attributes

Parameters:

conceptname - - Concept name

allAttributes - - 1, if all attributes are retrieved; 0, if no attribute is retrieved.

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.0

findConcept

public Concept findConcept(java.lang.String conceptname,
                           int namespaceId)

Retrieves the Concept corresponding to a specific Concept name in a specific namespace with all fetched attributes

Parameters:

conceptname - - Concept name

namespaceId - - namespace Id

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.0

findConcept

public Concept findConcept(java.lang.String conceptname,
                           int ASD_index,
                           int namespaceId)

Retrieves the Concept corresponding to a specific Concept name in a specific namespace

Parameters:

conceptname - - Concept name

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceId - - namespace Id

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.0

findConceptByCode

public Concept findConceptByCode(java.lang.String conceptcode)

Retrieves the Concept corresponding to a specific Concept code in the default namespace with all attributes retrieved

Parameters:

conceptcode - - Concept code

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.0

findConceptByCode

public Concept findConceptByCode(java.lang.String conceptcode,
                                 boolean allAttributes)

Retrieves the Concept corresponding to a specific Concept code in the default namespace

Parameters:

conceptcode - - Concept code

allAttributes - - boolean false, if no attribute is retrieved; true: if all attributes are retrieved

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.0

findConceptByCode

public Concept findConceptByCode(java.lang.String conceptcode,
                                 int namespaceId)

Retrieves the Concept corresponding to a specific Concept name in a specific namespace

Parameters:

conceptcode - - Concept code

namespaceId - - namespace Id

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.0

findConceptByCode

public Concept findConceptByCode(java.lang.String conceptcode,
                                 int ASD_index,
                                 int namespaceId)

Retrieves the Concept corresponding to a specific Concept name in a specific namespace

Parameters:

conceptcode - - Concept code

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceId - - namespace Id

Returns:

a Concept object Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSubs

public Concept[] getDirectSubs(java.lang.String conceptname)

Retrieves direct superconcepts of a specific Concept in a specific namespace

Parameters:

conceptname - - Concept name

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSubs

public Concept[] getDirectSubs(java.lang.String conceptname,
                               boolean allAttributes)

Retrieves direct superconcepts of a specific Concept in a specific namespace

Parameters:

conceptname - - Concept name

allAttributes - - boolean true, if all attributes are retrieved; false, if no attribute is retrieved

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSubs

public Concept[] getDirectSubs(java.lang.String conceptname,
                               int namespaceId)

Retrieves direct superconcepts of a specific Concept in a specific namespace

Parameters:

conceptname - - Concept name

namespaceId - - namespace Id

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSubs

public Concept[] getDirectSubs(java.lang.String conceptname,
                               int ASD_index,
                               int namespaceId)

Retrieves direct superconcepts of a specific Concept in a specific namespace

Parameters:

conceptname - - Concept name

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceId - - namespace Id

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSubs

public Concept[] getDirectSubs(java.lang.String inputvalue,
                               boolean inputcode,
                               int ASD_index,
                               int namespaceId)

Retrieves direct superconcepts of a specific Concept in a specific namespace

Parameters:

inputvalue - - Concept name, if inputcode is true; concept code, if otherwise

inputcode - - true, if inputvalue is a concept name, false, otherwise

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceId - - namespace Id

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.1

getDirectSups

public Concept[] getDirectSups(java.lang.String conceptname)

Retrieves direct superconcepts of a specific Concept in the default namespace. All attributes are retrieved.

Parameters:

conceptname - - Concept name

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSups

public Concept[] getDirectSups(java.lang.String conceptname,
                               boolean allAttributes)

Retrieves direct superconcepts of a specific Concept in the default namespace.

Parameters:

conceptname - - Concept name

allAttributes - - a boolean variable, true, if all attributes are retrieved; false, otherwise.

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSups

public Concept[] getDirectSups(java.lang.String conceptname,
                               int namespaceId)

Retrieves direct superconcepts of a specific Concept in a specific namespace. All attributes are retrieved.

Parameters:

conceptname - - Concept name

namespaceId - - namespace id

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSups

public Concept[] getDirectSups(java.lang.String conceptname,
                               int ASD_index,
                               int namespaceId)

Retrieves the direct superconcepts of a specific concept in a given namespace

Parameters:

conceptname - - Concept name

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceId - - namespace Id

Returns:

a an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getDirectSups

public Concept[] getDirectSups(java.lang.String inputvalue,
                               boolean inputcode,
                               int ASD_index,
                               int namespaceId)

Retrieves the direct superconcepts of a specific concept in a given namespace

Parameters:

inputvalue - - Concept name, if inputcode is true; concept code, if otherwise

inputcode - - true, if inputvalue is a concept name, false, otherwise

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceId - - namespace Id

Returns:

a an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.1

getRootConcepts

public Concept[] getRootConcepts()

Retrieves all root concepts of in the default namespace. All attributes are retrieved.

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getRootConcepts

public Concept[] getRootConcepts(int namespaceId)

Retrieves all root concepts of in a given namespace. All attributes are retrieved.

Parameters:

namespaceId - namespace id

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getRootConcepts

public Concept[] getRootConcepts(boolean allAttributes)

Retrieves all root concepts of in a given namespace.

Parameters:

allAttributes - - 1, if all attributes are retrieved; 0, if no attribute is retrieved.

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getRootConcepts

public Concept[] getRootConcepts(int ASD_index,
                                 int namespaceId)

Retrieves all root concepts of in a given namespace.

Parameters:

ASD_index - - attribute set descriptor index; 0, no attribute; 1: all attributes; 2: properties only; 3: roles only

namespaceId - - namespace Id

Returns:

an array of Concept objects Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptHistory

public ConceptHistory getConceptHistory(java.lang.String conceptcode)

Retrieves the ConceptHistory corresponding to a specific concept.

Parameters:

conceptcode - - concept code

Returns:

the ConceptHistory corresponding to a specific concept Returns null, if there is an exception.

Since:

DTSRPC 2.0

getConceptHistory

public ConceptHistory getConceptHistory(int namespaceId,
                                        java.lang.String conceptcode)

Retrieves the ConceptHistory corresponding to a specific concept in a given namespace

Parameters:

namespaceId - - namespace id

conceptcode - - concept code

Returns:

the ConceptHistory corresponding to a specific concept Returns null, if there is an exception.

Since:

DTSRPC 2.0

searchConcepts

public Concept[] searchConcepts(java.lang.String pattern,
                                int searchLimit)

Searches concepts that match with a specific search criteria

Parameters:

pattern - search pattern

searchLimit - search limit (the maximum number of matches)

Returns:

an array of Concept objects that match with a specific search criteria Returns null, if there is an exception.

Since:

DTSRPC 2.0

searchConcepts

public Concept[] searchConcepts(int namespaceId,
                                java.lang.String pattern,
                                int searchLimit)

Searches concepts in a given namespace that match with a specific search criteria

Parameters:

namespaceId - namespace id

pattern - search pattern

searchLimit - search limit (the maximum number of matches)

Returns:

an array of Concept objects that match with a specific search criteria Returns null, if there is an exception.

Since:

DTSRPC 2.0

searchConcepts

public Concept[] searchConcepts(SearchCriteria sc)

Searches concepts in accordance with search criteria as defined in a SearchCriteria object

Parameters:

sc - - a SearchCriteria object

Returns:

an array of Concept objects that match with a specific search criteria Returns null, if there is an exception.

Since:

DTSRPC 2.0

searchConcepts

public Concept[] searchConcepts(java.lang.String pattern,
                                int limit,
                                int matchOption,
                                java.lang.String matchType,
                                int ASDIndex)

Searches concepts in accordance with user specified search criteria

Parameters:

pattern - - search pattern

limit - - maximum number of matched concepts

matchOption - - match option

matchType - - match type (role or property name)

ASDIndex - - attribute set descriptor index

Returns:

an array of Concept objects that match with a specific search criteria Returns null, if there is an exception.

Since:

DTSRPC 2.0

searchConcepts

public Concept[] searchConcepts(int namespaceId,
                                java.lang.String pattern,
                                int limit,
                                int matchOption,
                                java.lang.String matchType,
                                int ASDIndex)

Searches concepts in accordance with user specified search criteria

Parameters:

namespaceId - - namespace Id

pattern - - search pattern

limit - - maximum number of matched concepts

matchOption - - match option

matchType - - match type (role or property name)

ASDIndex - - attribute set descriptor index

Returns:

an array of Concept objects that match with a specific search criteria Returns null, if there is an exception.

Since:

DTSRPC 2.0

getTree

public javax.swing.tree.DefaultMutableTreeNode getTree(java.lang.String rootname,
                                                       boolean direction,
                                                       AttributeSetDescriptor attributes)

Gets tree data from the server (UserObject is a Concept instance).

Parameters:

rootname - the name of the root concept

direction - a boolean variable set to true if tree traverses down, to false, if otherwise

attributes - a gov.nih.nci.dtsrpc.client.Concept instance

Returns:

a DefaultMutableTreeNode containing tree data

Since:

DTSRPC 2.0

getTree

public javax.swing.tree.DefaultMutableTreeNode getTree(java.lang.String rootname,
                                                       boolean direction,
                                                       int level,
                                                       AttributeSetDescriptor attributes)

Gets tree data from the server (UserObject is a Concept instance).

Parameters:

rootname - the name of the root concept

direction - a boolean variable set to true if tree traverses down, to false, if otherwise

level - maximum number of levels

attributes - a gov.nih.nci.dtsrpc.client.AttributeSetDescriptor instance

Returns:

a DefaultMutableTreeNode containing tree data

Since:

DTSRPC 2.0

getTree

public javax.swing.tree.DefaultMutableTreeNode getTree(java.lang.String rootname,
                                                       boolean direction,
                                                       int level,
                                                       AttributeSetDescriptor attributes,
                                                       int namespaceId)

Gets tree data from the server (UserObject is a Concept instance).

Parameters:

rootname - the name of the root concept

direction - a boolean variable set to true if tree traverses down, to false, if otherwise

level - maximum number of levels

attributes - a gov.nih.nci.dtsrpc.client.AttributeSetDescriptor instance

namespaceId - namespace Id

Returns:

a DefaultMutableTreeNode containing tree data

Since:

DTSRPC 2.0

getTree

public javax.swing.tree.DefaultMutableTreeNode getTree(java.lang.String rootname,
                                                       boolean direction,
                                                       int level,
                                                       AttributeSetDescriptor attributes,
                                                       boolean isaflag,
                                                       java.util.Vector rolenames)

Gets tree data from the server (UserObject is a Concept instance).

Parameters:

rootname - the name of the root concept

direction - a boolean variable set to true if tree traverses down, to false, if otherwise

level - maximum number of levels

attributes - a gov.nih.nci.dtsrpc.client.AttributeSetDescriptor instance

isaflag - a boolean value; set to true, if the tree contains taxonomy (is a relationships); to false, otherwise

rolenames - the names of role relationships

Returns:

a DefaultMutableTreeNode containing tree data

Since:

DTSRPC 2.0

printTree

public void printTree(java.io.PrintWriter treeWriter,
                      javax.swing.tree.DefaultMutableTreeNode root)

Print a tree (UserObject is a Concept instance).

Parameters:

treeWriter - an instance of PrintWriter

root - The root (DefaultMutableTreeNode) of the tree

Since:

DTSRPC 2.0

getTree

public javax.swing.tree.DefaultMutableTreeNode getTree(java.lang.String rootname,
                                                       boolean direction,
                                                       int levels,
                                                       java.lang.String propertyname)

Gets tree data from the server (UserObject is a Concept instance). Note: for DTS Browser

Parameters:

rootname - the name of the root concept

direction - a boolean variable set to true if tree traverses down, to false, if otherwise

levels - maximum number of levels

propertyname - - Provides the property name with which to populate returned concepts.

Returns:

The root (DefaultMutableTreeNode) of the tree

Since:

DTSRPC 2.0

getTree

public javax.swing.tree.DefaultMutableTreeNode getTree(java.lang.String rootname,
                                                       boolean direction,
                                                       int levels,
                                                       java.lang.String propertyname,
                                                       int namespaceId)

Gets tree data from the server (UserObject is a Concept instance).

Parameters:

rootname - the name of the root concept

direction - a boolean variable set to true if tree traverses down, to false, if otherwise

levels - maximum number of levels

propertyname - - Provides the property name with which to populate returned concepts.

namespaceId - namespace id

Returns:

The root (DefaultMutableTreeNode) of the tree

Since:

DTSRPC 2.0