Windward Engine API Reference
XPathDataSource Class Members
See Also  Properties  Methods  Send comments on this topic.
WindwardReportsDrivers.net.windward.datasource.xml Namespace : XPathDataSource Class


Glossary Item Box

The following tables list the members exposed by XPathDataSource.

Public Constructors

 NameDescription
Public ConstructorXPathDataSource ConstructorOverloaded.   
Top

Public Properties

 NameDescription
Public PropertyPropertiesAll of the properties for this datasource connection. Includes the password unencrypted.  
Public PropertyRootNodeReturns the root node for this data set. Outside of forEach loops this is the node all tag requests will be evaluated against.  
Top

Public Methods

 NameDescription
Public MethodapproveDenyModifySelect  
Public MethodcloseCalled when processing is complete. Used to close any resources opened by this object. Does nothing.  
Public MethodgetDatasourceNameReturns the name of this type in the form "sql", "xml", etc.  
Public MethodgetDefaultNamespacePrefixThe prefixes for namespaces are pulled from the XML datasource. The default namespace, if one exists, needs to be set. The default is def (ie /def:root/def:elem ).  
Public Methodstatic (Shared in Visual Basic)GetNativeValueReturn the nav.Value in the native type (bool, int, etc).  
Public MethodgetParametersReturns the map of variables for this datasource.  
Public MethodgetParamModeGet the parameter substitution mode.  
Public MethodgetQueryModeDetermine the query mode of a given string  
Public MethodgetRootNodeReturns the root node for this data set. Outside of forEach loops this is the node all tag requests will be evaluated against.  
Public MethodgetTagAttributesReturns the allowed attributes for all tags.  
Public MethodpopulateDatasourceExceptionPopulates that properties in a DataSourceException via DataSourceException.setProperties().  
Public MethodsetDefaultNamespacePrefixThe prefixes for namespaces are pulled from the XML datasource. The default namespace, if one exists, needs to be set. The default is def (ie /def:root/def:elem ).  
Public MethodSetNamespacesExplicitly set the namespaces for this datasource. This will remove all the default namespaces (if any) and/or namespaces previously explicitly set.  
Public MethodsetParametersSets the map that is used for ${variable} substitution. The map key values cannot have any of the characters ${} in them. When ${key} is found in any tag, it is replaced with the matching value. The value can be a string, number (int, float, etc), or datetime. The map is copied so on return changes to the passed in map will not affect the data source.  
Public MethodsetParamModeSet the parameter substitution mode.  
Public MethodsupportsDataSets  
Public MethodvalidateTagVerifys that a tag has all required attributes and no unknown attributes.  
Top

See Also

© 2019 All Rights Reserved.