com.dhtmlx.connector
Class BaseConnector

java.lang.Object
  extended by com.dhtmlx.connector.BaseConnector
Direct Known Subclasses:
ComboConnector, CommonConnector, DummyStringConnector, FormConnector, GridConnector, OptionsConnector, SchedulerConnector, SelectOptionsConnector, TreeConnector

public class BaseConnector
extends java.lang.Object

The Class BaseConnector. Class represents universal connector. It has not any component specific functionality, but can handler and parse common elements of incoming request.


Field Summary
 AccessManager access
          Access Manager instance
 ConnectorBehavior event
          Event extension
 java.util.HashMap<java.lang.String,java.lang.String> incoming_data
          The incoming_data.
 DataWrapper sql
          Data Wrapper instance
 
Constructor Summary
BaseConnector(java.sql.Connection db)
          Instantiates a new base connector.
BaseConnector(java.sql.Connection db, DBType db_type)
          Instantiates a new base connector.
BaseConnector(java.sql.Connection db, DBType db_type, BaseFactory a_factory)
          Instantiates a new base connector.
BaseConnector(java.sql.Connection db, DBType db_type, BaseFactory a_factory, RenderStrategy render_type)
          Instantiates a new base connector.
 
Method Summary
 void add_top_attribute(java.lang.String name, java.lang.String value)
           
 void dynamic_loading(boolean state)
          Enable dynamic loading Dynamic loading size set to 30 by default
 void dynamic_loading(int size)
          Set size of dynamic loading
 void enable_log(java.lang.String path, boolean output_to_client)
          enable logging
 java.lang.Boolean is_first_call()
           
 boolean is_select_mode()
          Checks if current mode is a select mode.
 void render_array(java.lang.Iterable<java.lang.Object> data, java.lang.String id, java.lang.String fields)
          Build xml response for specified iterable object
 void render_array(java.lang.Iterable<java.lang.Object> data, java.lang.String id, java.lang.String fields, java.lang.String extra)
          Build xml response for specified iterable object
 void render_array(java.lang.Iterable<java.lang.Object> data, java.lang.String id, java.lang.String fields, java.lang.String extra, java.lang.String relation_id)
          Build xml response for specified iterable object
 java.lang.String render_complex_sql(java.lang.String sql, java.lang.String id, java.lang.String fields)
          Build xml response for specified sql query in DB without parsing it
 java.lang.String render_complex_sql(java.lang.String sql, java.lang.String id, java.lang.String fields, java.lang.String extra)
          Build xml response for specified sql query in DB without parsing it
 java.lang.String render_complex_sql(java.lang.String sql, java.lang.String id, java.lang.String fields, java.lang.String extra, java.lang.String relation_id)
          Build xml response for specified sql query in DB without parsing it
 java.lang.String render_connector(DataConfig config, DataRequest request)
          Build xml response, based on specified config and data
 void render_sql(java.lang.String sql, java.lang.String id, java.lang.String fields)
          Render_sql.
 void render_sql(java.lang.String sql, java.lang.String id, java.lang.String fields, java.lang.String extra)
          Render_sql.
 void render_sql(java.lang.String sql, java.lang.String id, java.lang.String fields, java.lang.String extra, java.lang.String relation_id)
          Build xml response for specified sql query in DB
 void render_table(java.lang.String table, java.lang.String id, java.lang.String fields)
          Build xml response for specified table in DB
 void render_table(java.lang.String table, java.lang.String id, java.lang.String fields, java.lang.String extra)
          Build xml response for specified table in DB
 void render_table(java.lang.String table, java.lang.String id, java.lang.String fields, java.lang.String extra, java.lang.String relation_id)
          Build xml response for specified table in DB
 java.lang.String render()
          Build xml response, based on previously provided configuration All top level render methods, call this one, after parsing provided configuration
 void servlet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Link connector to active request and response
 void set_encoding(java.lang.String name)
          Sets used xml encoding.
 void set_options(java.lang.String name, BaseConnector connector)
          Define connector for options retrieving
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

incoming_data

public java.util.HashMap<java.lang.String,java.lang.String> incoming_data
The incoming_data.


access

public AccessManager access
Access Manager instance


sql

public DataWrapper sql
Data Wrapper instance


event

public ConnectorBehavior event
Event extension

Constructor Detail

BaseConnector

public BaseConnector(java.sql.Connection db)
Instantiates a new base connector.

Parameters:
db - DB connecton

BaseConnector

public BaseConnector(java.sql.Connection db,
                     DBType db_type)
Instantiates a new base connector.

Parameters:
db - DB connection
db_type - type of used DB

BaseConnector

public BaseConnector(java.sql.Connection db,
                     DBType db_type,
                     BaseFactory a_factory)
Instantiates a new base connector.

Parameters:
db - DB connection
db_type - type of used DB
a_factory - class factory

BaseConnector

public BaseConnector(java.sql.Connection db,
                     DBType db_type,
                     BaseFactory a_factory,
                     RenderStrategy render_type)
Instantiates a new base connector.

Parameters:
db - DB connection
db_type - type of used DB
a_factory - class factory
render_type - class render_strategy
Method Detail

render_table

public void render_table(java.lang.String table,
                         java.lang.String id,
                         java.lang.String fields)
Build xml response for specified table in DB

Parameters:
table - the name of table
id - the name of id field
fields - the name of data fields

render_table

public void render_table(java.lang.String table,
                         java.lang.String id,
                         java.lang.String fields,
                         java.lang.String extra)
Build xml response for specified table in DB

Parameters:
table - the name of table
id - the name of id field
fields - the name of data fields
extra - the name of extra fields

render_table

public void render_table(java.lang.String table,
                         java.lang.String id,
                         java.lang.String fields,
                         java.lang.String extra,
                         java.lang.String relation_id)
Build xml response for specified table in DB

Parameters:
table - the name of table
id - the name of id field
fields - the name of data fields
extra - the name of extra fields
relation_id - the name of relation field

render_sql

public void render_sql(java.lang.String sql,
                       java.lang.String id,
                       java.lang.String fields)
Render_sql.

Parameters:
sql - the sql query
id - the name of id field
fields - the name of data fields

render_sql

public void render_sql(java.lang.String sql,
                       java.lang.String id,
                       java.lang.String fields,
                       java.lang.String extra)
Render_sql.

Parameters:
sql - the sql query
id - the name of id field
fields - the name of data fields
extra - the name of extra fields

render_sql

public void render_sql(java.lang.String sql,
                       java.lang.String id,
                       java.lang.String fields,
                       java.lang.String extra,
                       java.lang.String relation_id)
Build xml response for specified sql query in DB

Parameters:
sql - the sql query
id - the name of id field
fields - the name of data fields
extra - the name of extra fields
relation_id - the name of relation field

render_complex_sql

public java.lang.String render_complex_sql(java.lang.String sql,
                                           java.lang.String id,
                                           java.lang.String fields,
                                           java.lang.String extra)
Build xml response for specified sql query in DB without parsing it

Parameters:
sql - the sql query
id - the name of id field
fields - the name of data fields
extra - the name of extra fields

render_complex_sql

public java.lang.String render_complex_sql(java.lang.String sql,
                                           java.lang.String id,
                                           java.lang.String fields)
Build xml response for specified sql query in DB without parsing it

Parameters:
sql - the sql query
id - the name of id field
fields - the name of data fields

render_complex_sql

public java.lang.String render_complex_sql(java.lang.String sql,
                                           java.lang.String id,
                                           java.lang.String fields,
                                           java.lang.String extra,
                                           java.lang.String relation_id)
Build xml response for specified sql query in DB without parsing it

Parameters:
sql - the sql query
id - the name of id field
fields - the name of data fields
extra - the name of extra fields
relation_id - the name of relation field

render_connector

public java.lang.String render_connector(DataConfig config,
                                         DataRequest request)
Build xml response, based on specified config and data

Parameters:
config - the data config
request - the data request
Returns:
the xml string

render_array

public void render_array(java.lang.Iterable<java.lang.Object> data,
                         java.lang.String id,
                         java.lang.String fields)
Build xml response for specified iterable object

Parameters:
iterable - data
id - the name of id field
fields - the name of data fields
extra - the name of extra fields

render_array

public void render_array(java.lang.Iterable<java.lang.Object> data,
                         java.lang.String id,
                         java.lang.String fields,
                         java.lang.String extra)
Build xml response for specified iterable object

Parameters:
iterable - data
id - the name of id field
fields - the name of data fields
extra - the name of extra fields

render_array

public void render_array(java.lang.Iterable<java.lang.Object> data,
                         java.lang.String id,
                         java.lang.String fields,
                         java.lang.String extra,
                         java.lang.String relation_id)
Build xml response for specified iterable object

Parameters:
iterable - data
id - the name of id field
fields - the name of data fields
extra - the name of extra fields
relation_id - the name of relation field

render

public java.lang.String render()
Build xml response, based on previously provided configuration All top level render methods, call this one, after parsing provided configuration

Returns:
the xml string

servlet

public void servlet(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
Link connector to active request and response

Parameters:
request - the http request
response - the http response

is_first_call

public java.lang.Boolean is_first_call()

set_encoding

public void set_encoding(java.lang.String name)
Sets used xml encoding.

Parameters:
name - the encoding name

dynamic_loading

public void dynamic_loading(int size)
Set size of dynamic loading

Parameters:
size - the size

dynamic_loading

public void dynamic_loading(boolean state)
Enable dynamic loading Dynamic loading size set to 30 by default

Parameters:
state - the mode, true will enable dyn. loading, false will disable it

enable_log

public void enable_log(java.lang.String path,
                       boolean output_to_client)
enable logging

Parameters:
path - the path to the log file
output_to_client - if mode is set, error data will be sent to client side , which provides a simpler debugging, but not safe for production environment

is_select_mode

public boolean is_select_mode()
Checks if current mode is a select mode.

Returns:
true, if current mode is a select mode

set_options

public void set_options(java.lang.String name,
                        BaseConnector connector)
Define connector for options retrieving

Parameters:
name - the name of column
connector - the connector

add_top_attribute

public void add_top_attribute(java.lang.String name,
                              java.lang.String value)