ilog.views.chart.faces.component.data

Class IlvFacesJDBCMapping

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

ilog.views.faces.component.IlvFacesComponentBase

ilog.views.chart.faces.component.data.IlvFacesJDBCMapping

All Implemented Interfaces:

IlvChartConstants, IlvFacesComponent, IlvFacesConstants, Serializable, EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class IlvFacesJDBCMapping
extends IlvFacesComponentBase
implements IlvChartConstants

This class defines a mapping of a data set x, y and label values to the corresponding columns of a JDBC query.
The column identifier is the column number or the column name.

Since:

JViews 6.5

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface ilog.views.chart.faces.IlvChartConstants

AUTO_REFRESH, CHART, DATA_SOURCE, DATA_SOURCE_ID, DATABASE_DRIVER, DATABASE_PASSWORD, DATABASE_QUERY, DATABASE_RESULT_SET, DATABASE_URL, DATABASE_USER, FILENAME, INTERACTOR, INTERACTOR_ID, ITEM_PICKING, KEEP_VISIBLE_WINDOW, LABEL_COLUMN_MAPPING, LAYOUT, LEGEND_LAYOUT, MESSAGEBOX, NEAREST_ITEM_PICKING, NEAREST_POINT_PICKING, OVERVIEW_ACTION_NAME, PAN_ACTION_NAME, PICKING_MODE, REFRESH_DATA, SESSION_ID_PREFIX, STATE_URL, STYLE_SHEET, STYLE_SHEETS, TYPE, UPDATE_INTERVAL, X_COLUMN_MAPPING, X_PAN_ALLOWED, X_ZOOM_ALLOWED, X_ZOOM_FACTOR, Y_COLUMN_MAPPING, Y_PAN_ALLOWED, Y_ZOOM_ALLOWED, Y_ZOOM_FACTOR, ZOOM_ACTION_NAME

Fields inherited from interface ilog.views.faces.IlvFacesConstants

AFTER_HANDLER, BASETEXTDIRECTION, BEFORE_HANDLER, BUTTON_GROUP_ID, BUTTON_TYPE, CHARTS_BUNDLE, CHARTS_MESSAGE_BUNDLE, CORE_BUNDLE, CORE_MESSAGE_BUNDLE, CURSOR, DATA, DECODED_PROPERTY, DEFAULT_LINE_COLOR, DELETION_ALLOWED, DIAGRAMMER_BUNDLE, DIAGRAMMER_MESSAGE_BUNDLE, ENABLED, EVENT_TYPE, FILL_ON, FORCE_UPDATE_PROPERTIES, FRAMEWORK_BUNDLE, FRAMEWORK_MESSAGE_BUNDLE, GANTT_BUNDLE, GANTT_MESSAGE_BUNDLE, HEIGHT, IMAGE, IMAGE_MODE, INFO_PROVIDER_MB, INT_NOT_DEFINED, INTERACTORS, INTERCEPT_INTERACTOR, ITEM_DISABLED_STYLE_CLASS, ITEM_HIGHLIGHTED_STYLE_CLASS, ITEM_STYLE_CLASS, LINE_COLOR, LINE_WIDTH, MAPS_BUNDLE, MAPS_MESSAGE_BUNDLE, MENU_MODEL_ID, MESSAGE, MESSAGE_BOX, MESSAGE_BOX_ID, MOVE_ALLOWED, OBJECT_FINDER, PARAM_COMPID, PARAM_DATA, PARAM_KEY, PARAM_NAMESPACE, PARAM_RESOURCE, PARAM_SERVICE, PARAM_TYPE, POPUP_MENU, POPUP_MENU_FACTORY, POPUP_MENU_FACTORY_CLASS, PORTLET_NAMESPACE, PROGRESSIVE_ZOOM, PROJECT, RENDER, RESOURCES_PATH, RESOURCES_PATH_PREFIX, ROLLOVER_IMAGE, SCROLL_BAR, SELECTED, SELECTED_IMAGE, SERVICE_FORWARD, SERVICE_FORWARD_INT, SERVLET, SERVLET_CLASS, SERVLET_URL, STYLE, STYLE_CLASS, TGO_BUNDLE, TGO_MESSAGE_BUNDLE, TITLE, TOGGLE, VALUE, VIEW, VIEW_ID, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvFacesJDBCMapping() Creates a new IlvFacesJDBCMapping instance.

Method Summary

Modifier and Type	Method and Description
static String	getComponentType() Returns the type of this component.
String	getFamily() Returns the family of this component.
String	getLabelColumn() Returns the labelColumn.
String	getXColumn() Returns the xColumn.
String	getYColumn() Returns the YColumn.
void	restoreState(javax.faces.context.FacesContext context, Object stateObj) Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(javax.faces.context.FacesContext context) Gets the state of the instance as a Serializable Object.
void	setLabelColumn(String labelColumn) Sets the labelColumn.
void	setxColumn(String xColumn) Sets the xColumn.
void	setXColumn(String xColumn) Sets the xColumn.
void	setyColumn(String yColumn) Sets the YColumn.
void	setYColumn(String yColumn) Sets the YColumn.
void	updateModel(javax.faces.context.FacesContext context) Handles the "Update Model Values" phase of the JSF life cycle.

Methods inherited from class ilog.views.faces.component.IlvFacesComponentBase

clearDecodedPropertyMap, createFacesComponent, getAttributes, getClientId, isDecodedProperty, processUpdates, resetDecodedProperties, setDecodedProperty

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvFacesJDBCMapping

public IlvFacesJDBCMapping()

Creates a new IlvFacesJDBCMapping instance.

Method Detail

getFamily

public String getFamily()

Returns the family of this component.

Specified by:

getFamily in class javax.faces.component.UIComponent

Returns:

The family of this component.

getComponentType

public static String getComponentType()

Returns the type of this component.

Returns:

The type of this component.

getXColumn

public String getXColumn()

Returns the xColumn.

Returns:

The xColumn.

setXColumn

public void setXColumn(String xColumn)

Sets the xColumn.

Parameters:

xColumn - The xColumn to set.

setxColumn

public void setxColumn(String xColumn)

Sets the xColumn.

Parameters:

xColumn - The xColumn to set.

getYColumn

public String getYColumn()

Returns the YColumn.

Returns:

The YColumn.

setYColumn

public void setYColumn(String yColumn)

Sets the YColumn.

Parameters:

yColumn - The YColumn to set.

setyColumn

public void setyColumn(String yColumn)

Sets the YColumn.

Parameters:

yColumn - The YColumn to set.

getLabelColumn

public String getLabelColumn()

Returns the labelColumn.

Returns:

The labelColumn.

setLabelColumn

public void setLabelColumn(String labelColumn)

Sets the labelColumn.

Parameters:

labelColumn - The labelColumn to set.

updateModel

public void updateModel(javax.faces.context.FacesContext context)

Handles the "Update Model Values" phase of the JSF life cycle. This method updates the referenced values with the local values of the component if theses values were updated during the "Apply Request Values" phase.

Overrides:

updateModel in class IlvFacesComponentBase

Parameters:

context - The current faces context.

saveState

public Object saveState(javax.faces.context.FacesContext context)

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets.

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface IlvFacesComponent

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class IlvFacesComponentBase

Parameters:

context - The current faces context.

Returns:

The state of this component.

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object stateObj)

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the IlvFacesComponentBase.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:

restoreState in interface IlvFacesComponent

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class IlvFacesComponentBase

Parameters:

context - The current faces context.

stateObj - The previously saved state of this component.