Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %iKnow.Queries.PathQAPI
Private  Storage   

%iKnow.Queries.PathQAPI


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.

This class was generated by %iKnow.Queries.PathAPI.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
24 5


Summary


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
GetCountByDomain GetCountByEntities GetCountByEntityIds GetCountBySource
GetId GetSentenceId GetSourceId GetValue


Methods


• classmethod GetCountByDomain(domainid As %Integer, filter As %String(MAXLEN=32767)="", Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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.

• classmethod GetCountByEntities(domainid As %Integer, entitylist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

Retrieves the number of paths containing the specified entities.

See also GetByEntities for a description of the parameters.

• classmethod GetCountByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, Output scText As %String = "", pActualFormOnly As %Boolean = 0) as %Library.Integer [ SQLProc = ]

Retrieves the number of paths containing the specified entity IDs.

See also GetByEntities for a description of the parameters.

• classmethod GetCountBySource(domainid As %Integer, sourceidlist As %String(MAXLEN=32767), Output scText As %String = "") as %Library.Integer [ SQLProc = ]

Returns the total number of paths in the sources specified through sourceidlist. Use negative source IDs to refer to virtual sources.

• classmethod GetId(domainid As %Integer, entityList As %String(MAXLEN=32767), vSrcId As %Integer = 0, Output scText As %String = "") as %Library.Integer [ SQLProc = ]

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.

• classmethod GetSentenceId(domainId As %Integer, pathId As %Integer, Output scText As %String = "", vSrcId As %Integer = 0) as %Library.Integer [ SQLProc = ]
Returns the sentence ID in which the supplied path ID occurs
• classmethod GetSourceId(domainId As %Integer, pathId As %Integer, Output scText As %String = "") as %Library.Integer [ SQLProc = ]
Returns the source ID in which the supplied path ID occurs
• classmethod GetValue(domainid As %Integer, pathid As %Integer, vSrcId As %Integer = 0, Output scText As %String = "", pUseStems As %Boolean = 0) as %String [ SQLProc = ]

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


• query GetAttributes(pDomainId As %Integer, pPathId As %Integer, vSrcId As %Integer = 0)
Selects attTypeId As %Integer, attType As %String(MAXLEN=32767), start As %Integer, span As %Integer, properties As %String(MAXLEN=32767)

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.

• query GetByEntities(domainid As %Integer, entitylist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, pActualFormOnly As %Boolean = 0)
Selects pathId As %Integer, entIds As %List

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.

• query GetByEntityIds(domainid As %Integer, entityidlist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10, filter As %String(MAXLEN=32767)="", setop As %Integer = $$$UNION, pActualFormOnly As %Boolean = 0)
Selects pathId As %Integer, entIds As %List

Retrieves paths based on entity IDs.

See also GetByEntities for a description of the parameters.

• query GetBySource(domainid As %Integer, sourceidlist As %String(MAXLEN=32767), page As %Integer = 1, pagesize As %Integer = 10)
Selects pathId As %Integer, entIds As %List

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).

• query GetEntities(domainId As %Integer, pathId As %Integer, vSrcId As %Integer = 0)
Selects position As %Integer, entOccId As %Integer, entUniId As %Integer, entityValue As %String(MAXLEN=32767), literal As %String(MAXLEN=32767), role As %Integer, stemUniId As %Integer, stemValue As %String(MAXLEN=32767)

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.