Style Intelligence v12.0

inetsoft.uql
Class XDataSource

java.lang.Object
  extended by inetsoft.uql.XDataSource
All Implemented Interfaces:
inetsoft.util.XMLSerializable, Serializable, Cloneable
Direct Known Subclasses:
HierDataSource, JDBCDataSource, TabularDataSource, XMLADataSource

public abstract class XDataSource
extends Object
implements Serializable, Cloneable, inetsoft.util.XMLSerializable

XDataSource defines the API for all data sources. All data source classes are extended from this class, and may choose to add more attributes suitable for that partiular data source type.

See Also:
Serialized Form

Field Summary
static String CORBA
          CORBA data source.
static int DOMAIN_DB2
          Db2 olap domain.
static int DOMAIN_NONE
          Domain not supported.
static int DOMAIN_ORACLE
          Oracle olap domain.
static int DOMAIN_SQL
          Default relational SQL based domain.
static int DOMAIN_SQLSERVER
          SQL server olap domain.
static String EJB
          EJB entity bean data source.
static String JDBC
          JDBC (SQL) data source.
static String OBJECT
          Application object data source.
static String SAP
          SAP data source.
static String SOAP
          SOAP data source.
static String TEXT
          Delimited text data source.
static String XML
          XML data source.
static String XMLA
          XMLA data source.
 
Constructor Summary
protected XDataSource(String type)
          Create a data source of the specified type.
 
Method Summary
 void addFolder(String folder)
          Add a query folder to the datasource.
 Object clone()
          Create a clone of this object.
 boolean equals(Object obj)
          Check if equals another object.
 String getDescription()
          Get the description of this data source.
 int getDomainType()
          Get the domain type associated with this datasource.
 String[] getFolders()
          Get all folders of a datasource.
 String getFullName()
          Get the data source full name.
 String getName()
          Get the data source name.
abstract  UserVariable[] getParameters()
          Get the data source connection parameters.
protected  String getRuntimeValue(String str)
          Replace with environment variable.
 String getType()
          Get the type of the data source.
 int hashCode()
          Get the hash code value.
 boolean isMVEnabled()
          Return if materialized view is allowed to create on this datasource.
 void parseXML(Element root)
          Parse the XML element that contains information on this data source.
 void removeFolder(String folder)
          Remove a query folder from the datasource.
 void removeFolders()
          Remove all the query folders.
 void setDescription(String desc)
          Set the description of this data source.
 void setName(String name)
          Set the data source name.
 String toString()
          Get the string representation.
 void writeXML(PrintWriter writer)
          Generate the XML segment to represent this data source.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

JDBC

public static String JDBC
JDBC (SQL) data source.


XML

public static String XML
XML data source.


CORBA

public static String CORBA
CORBA data source.


EJB

public static String EJB
EJB entity bean data source.


TEXT

public static String TEXT
Delimited text data source.


SOAP

public static String SOAP
SOAP data source.


OBJECT

public static String OBJECT
Application object data source.


XMLA

public static String XMLA
XMLA data source.


SAP

public static String SAP
SAP data source.


DOMAIN_NONE

public static final int DOMAIN_NONE
Domain not supported.

See Also:
Constant Field Values

DOMAIN_SQL

public static final int DOMAIN_SQL
Default relational SQL based domain.

See Also:
Constant Field Values

DOMAIN_ORACLE

public static final int DOMAIN_ORACLE
Oracle olap domain.

See Also:
Constant Field Values

DOMAIN_DB2

public static final int DOMAIN_DB2
Db2 olap domain.

See Also:
Constant Field Values

DOMAIN_SQLSERVER

public static final int DOMAIN_SQLSERVER
SQL server olap domain.

See Also:
Constant Field Values
Constructor Detail

XDataSource

protected XDataSource(String type)
Create a data source of the specified type.

Method Detail

getParameters

public abstract UserVariable[] getParameters()
Get the data source connection parameters.


setName

public void setName(String name)
Set the data source name. The name of a data source must be unique in a given registry.


getName

public String getName()
Get the data source name.


getFullName

public String getFullName()
Get the data source full name.


getType

public String getType()
Get the type of the data source.

Returns:
data source type, one of the value defined in this class.

getDomainType

public int getDomainType()
Get the domain type associated with this datasource. Return DOMAIN_NONE if this datasource does not support domain.


setDescription

public void setDescription(String desc)
Set the description of this data source.


getDescription

public String getDescription()
Get the description of this data source.


addFolder

public void addFolder(String folder)
Add a query folder to the datasource.


removeFolder

public void removeFolder(String folder)
Remove a query folder from the datasource.


getFolders

public String[] getFolders()
Get all folders of a datasource.


removeFolders

public void removeFolders()
Remove all the query folders.


parseXML

public void parseXML(Element root)
              throws Exception
Parse the XML element that contains information on this data source.

Specified by:
parseXML in interface inetsoft.util.XMLSerializable
Throws:
Exception

writeXML

public void writeXML(PrintWriter writer)
Generate the XML segment to represent this data source.

Specified by:
writeXML in interface inetsoft.util.XMLSerializable

clone

public Object clone()
Create a clone of this object.

Overrides:
clone in class Object

hashCode

public int hashCode()
Get the hash code value.

Overrides:
hashCode in class Object

isMVEnabled

public boolean isMVEnabled()
Return if materialized view is allowed to create on this datasource.


equals

public boolean equals(Object obj)
Check if equals another object.

Overrides:
equals in class Object

toString

public String toString()
Get the string representation.

Overrides:
toString in class Object

getRuntimeValue

protected String getRuntimeValue(String str)
Replace with environment variable.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.