%iKnow.Queries.PathQAPI
deprecated class %iKnow.Queries.PathQAPI extends %iKnow.Queries.AbstractQAPI
This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Queries.PathAPI, exposed as SqlProc methods.
See the classdocs for %iKnow.Queries.PathAPI for more information.
Method Inventory
- GetCountByDomain()
- GetCountByEntities()
- GetCountByEntityIds()
- GetCountBySource()
- GetId()
- GetSentenceId()
- GetSourceId()
- GetValue()
Methods
Returns the number of paths in a domain, optionally restricted to those appearing in a source satisfying the %iKnow.Filters.Filter object supplied through filter.
Retrieves the number of paths containing the specified entities.
See also GetByEntities() for a description of the parameters.
Retrieves the number of paths containing the specified entity IDs.
See also GetByEntities() for a description of the parameters.
Returns the total number of paths in the sources specified through sourceidlist. Use negative source IDs to refer to virtual sources.
This method will try to find a path corresponding to the supplied list of entities in the specified order. If no path is found, "" is returned.
When specifying a Virtual Source ID, it will treat the path as a virtual one, in the context of that vSrcId.
Returns the sequence of entity values corresponding to the specified path as a %List.
When specifying a Virtual Source ID, it will treat the pathId as a virtual one, in the context of that vSrcId.
If stemming is enabled for this domain through the $$$IKPSTEMMING domain parameter, you can use pUseStems=1 to get the stems rather than the entities for this path.
Queries
Returns all attributes for a given path. Any named attribute properties are also included through sub-nodes (not available through SQL or SOAP):
pResult(rowNumber, propertyName) = propertyValue
Please note this query only returns path-level attributes and not those attributes applying to individual entities or words within entities. To retrieve these, use GetOccurrenceAttributes() in %iKnow.Queries.EntityAPI.
This method will return all Paths containing any (if setop = $$$UNION) or all (if setop = $$$INTERSECT) of the entities in the supplied entitylist.
The scope of this query can be limited through supplying a %iKnow.Filters.Filter object for the filter parameter to restrict the result to those Paths occurring in any source satisfying the filter criteria.
Results are sorted by decreasing path ID.
If stemming is enabled for this domain through $$$IKPSTEMMING, paths containing any actual form of the entities in entitylist will be returned. Use pActualFormOnly=1 to retrieve only those paths containing the actual forms in entitylist. This argument is ignored if stemming is not enabled.
Retrieves paths based on entity IDs.
See also GetByEntities() for a description of the parameters.
Retrieves the paths appearing in any of the sources supplied through sourceidlist.
To get the paths of a virtual source, only a single virtual source can be supplied using its negative ID value (otherwise, -1 is returned).
Returns a detailed overview of the entities pathId consists of, including their unique and occurrence IDs, positions, roles and literal value.
The last two columns will only contain data if stemming is enabled for this domain through the $$$IKPSTEMMING domain parameter.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()