info.informatica.ui
Interface DataViewConfig

All Known Implementing Classes:

DataViewMap, DefaultDataViewConfig, HTMLViewConfig, HTTPViewConfig

public interface DataViewConfig

Configuration of the DataView.

Author:

amengual at informatica dot info

Method Summary

void	addMetadataName(String mdname)
DataView	createDataView(String viewId) Creates an instance of the DataView associated to this ViewConfig.
String	getControlClass(ControlName ui_name) Gets the class name that represents the UI element identified by ui_name
Map<String,Object>	getControlDefaults() Get the defaults of the fields, as specified in the View configuration.
ControlName	getControlName(FieldName field_name) Gets the name that the given field_name would have in this User Interface.
Iterator<ControlName>	getControlNames() Gets the names of the UI entity fields associated to UI items.
FieldName	getFieldName(ControlName ui_name) Gets the field name associated to the given User Interface object name.
LocalLabels	getLocalLabels() Gets the localized labels for the current view locale.
String	getViewClass() Gets the name of the DataView class associated to this ViewConfig.
boolean	isMetadataName(String name) Checks whether the given name is one of the datasource metadata names associated to the view.
String	pickMetadataName()
void	setLocalLabels(LocalLabels labels) Sets the localized labels for the current view locale.
void	setViewClass(String classname) Sets the name of the class used to produce the DataView

Method Detail

getControlName

ControlName getControlName(FieldName field_name)

Gets the name that the given field_name would have in this User Interface.

If there are more than one, returns any of them. If there is none, should return null (some basic implementations may always return a valid control name).

Parameters:

field_name - the (data) field name.

Returns:

the (user interface) control name.

getFieldName

FieldName getFieldName(ControlName ui_name)

Gets the field name associated to the given User Interface object name.

getControlClass

String getControlClass(ControlName ui_name)

Gets the class name that represents the UI element identified by ui_name

getControlNames

Iterator<ControlName> getControlNames()

Gets the names of the UI entity fields associated to UI items.

setViewClass

void setViewClass(String classname)

Sets the name of the class used to produce the DataView

Parameters:

classname - Name of the DataView-inherited class associated to this ViewConfig.

getViewClass

String getViewClass()

Gets the name of the DataView class associated to this ViewConfig.

Returns:

the name of the DataView associated to this ViewConfig.

addMetadataName

void addMetadataName(String mdname)

isMetadataName

boolean isMetadataName(String name)

Checks whether the given name is one of the datasource metadata names associated to the view.

Returns:

true if it is one of the datasource names associated to the view, or false if not.

pickMetadataName

String pickMetadataName()

createDataView

DataView createDataView(String viewId)
                        throws DataViewException

Creates an instance of the DataView associated to this ViewConfig.

Parameters:

viewId - the name of the view.

Returns:

a new DataView associated to this ViewConfig.

Throws:

DataViewException

setLocalLabels

void setLocalLabels(LocalLabels labels)

Sets the localized labels for the current view locale.

Parameters:

labels - the local labels.

getLocalLabels

LocalLabels getLocalLabels()

Gets the localized labels for the current view locale.

Returns:

the local labels, or null if not available.

getControlDefaults

Map<String,Object> getControlDefaults()

Get the defaults of the fields, as specified in the View configuration.

Returns:

a Map with the field default values, as they were specified in the View configuration. An empty Map indicates no defaults were specified.