Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.weda.store
Interface ObjectSource

All Superinterfaces:
ActionContainer, RowSelectionModel
All Known Implementing Classes:
ObjectSourceImpl
public interface ObjectSource
extends RowSelectionModel, ActionContainer

Цель:

Author:
tim

Nested Class Summary
static class ObjectSource.Mode
           
 
Method Summary
 void activateDetailConstraints(java.lang.Object masterObject, boolean masterPropertiesOnly)
          Метод устанавливает ограничения на подчиненных источниках данных.
 void addConstraint(ObjectSourceConstraint constraint)
          Метод добавляет ограничение к источнику данных.
 void addDetailInfo(DetailObjectSourceInfo detailDataSourceInfo)
          Метод добавляет информацию об источнике данных который является подчиненным по отношению к данному.
 void addListener(ObjectSourceListener listener)
          Метод добавляет слушателя к источнику объектов.
 void applyModification()
          Метод сохраняет изменения, но не фиксирует их.
 void beginModification()
          Вызов данного метода перевовит datasource в режим редактирования ObjectSource.Mode.EDIT.
 void cancelModification()
          Метод отменяет изменения произведенные над выделенными строками.
 java.lang.Object clone()
           
 void close()
          Метод закрывает источник данных если тот не находится в состоянии ObjectSource.Mode.CLOSED.
 void createNewRow()
          Метод создает новую запись в источнике данных, выбирает ее и начинает процесс изменения, вызывая метод beginModification().
 void deactivateDetailConstraints()
          Метод снимает ограничения с подчиненных источников данных.
 java.lang.Class getBaseClass()
          Метод возвращает класс являющийся базовым для источника данных.
 java.lang.String getBaseClassAlias()
          Метод возвращает alias базового класса в запросе.
 int getBaseClassPosition()
          Метод возвращает позицию базового класса в строке.
 java.util.Collection<DetailObjectSourceInfo> getDetailInfos()
          Метод возвращает информацию об подчиненных источниках данных.
 ObjectSource.Mode getMode()
          Метод возвращает режим в котором работает источник данных
 java.lang.String getName()
          Метод возвращает имя источника данных.
 Query getQuery()
          Метод возвращает запрос, при помощи которого будет получен результирующий набор данных.
 QueryFilter getQueryFilter()
          Метод возвращает фильтр для источника данных.
 java.lang.Object[] getRowAt(int row)
          Метод возвращает строку в указанной позиции
 int getRowCount()
          Метод возвращает количество строк в источнике данных на текущий момент
 ObjectSet getSelectedObjectSet()
          Метод возвращает множество объектов выделенных в текущий момент времени и доступный для редактирования.
 int getSelectedRowCount()
          Метод возвращает количество выделенных строк.
 java.util.Set<java.lang.Integer> getSelectedRows()
          Метод возвращает позиции выделенных в источнике данных строк.
 SummaryRow getSummaryRow()
          Метод возвращает стоку содержащую сводную информацию в разрезе строк источника объектов.
 boolean hasSelectedRows()
          Метод вернет true если в источнике данных есть выделенные строки
 void init()
           
 boolean isDetailConstraintsActivated()
          Метод вернет TRUE если ограничения на подчиненных источниках данных были установлены, но еще не были сняты.
 boolean isModificationApplied()
          Метод вернет TRUE если между вызовами методов beginModification() и saveModification() || cancelModification был успешно выполнен метод applyModification.
 boolean isReadOnly()
          Метод вернет TRUE если в источник данных нельзя вносить изменения.
 void open()
          Метод открывает источник объектов если тот находится в состояние ObjectSource.Mode.CLOSED.
 void refresh()
          Метод закрывает, а затем открывает источник объектов.
 void refresh(java.lang.Object baseClassObject)
          Метод делает следующее: закрывает источник объектов настраивает фильтр таким образом, что бы после открытия появились только те строки в которых значение объекта базового класса равнялись объекту переданному в параметре.
 void removeConstraint(ObjectSourceConstraint constraint)
          Метод снимает ограничение с источника данных.
 void removeListener(ObjectSourceListener listener)
          Метод удаляет слушателя.
 void removeSelectedRows()
          Метод удаляет выделенные строки в источнике объектов.
 void saveModification()
          Метод фиксирует изменения произведенные над выделенными строками.
 void setBaseClass(java.lang.Class baseClass)
          Метод устанавливает класс являющийся базовым для источника данных.
 void setBaseClassPosition(int position)
          Метод устанавливает позицию базового класса в строке.
 void setMode(ObjectSource.Mode mode)
          Метод устанавливает режим в котором работает источник данных
 void setQuery(Query query)
          Метод устанавливает запрос, при помощи которого будет получен результирующий набор данных.
 void setQueryFilter(QueryFilter queryFilter)
          Метод задает фильтр для источника данных.
 void setReadOnly(boolean readOnly)
          Если передать TRUE то в источник данных будет нельзя вносить изменения.
 
Methods inherited from interface org.weda.model.RowSelectionModel
deselectRow, getSelectedRow, isRowSelected, selectRow
 
Methods inherited from interface org.weda.action.ActionContainer
executeAction, getActionContainerName, getActionsStates, getDisabledActions, hasRegisteredActions
 

Method Detail

init

void init()
          throws ObjectSourceException
Throws:
ObjectSourceException

getName

java.lang.String getName()
Метод возвращает имя источника данных.

getMode

ObjectSource.Mode getMode()
Метод возвращает режим в котором работает источник данных

setMode

void setMode(ObjectSource.Mode mode)
Метод устанавливает режим в котором работает источник данных

isReadOnly

boolean isReadOnly()
Метод вернет TRUE если в источник данных нельзя вносить изменения.

setReadOnly

void setReadOnly(boolean readOnly)
Если передать TRUE то в источник данных будет нельзя вносить изменения.

open

void open()
          throws ObjectSourceException
Метод открывает источник объектов если тот находится в состояние ObjectSource.Mode.CLOSED. Т.е. в источнике данных появляются строки соответствующие запросу и установленому фильтру. После выполнения метода источник объектов переводится в состояние ObjectSource.Mode.VIEW.

Throws:
ObjectSourceException
See Also:
setQuery(Query), setQueryFilter(QueryFilter), close(), refresh(), refresh(Object)

refresh

void refresh()
             throws ObjectSourceException
Метод закрывает, а затем открывает источник объектов.

Throws:
ObjectSourceException
See Also:
open(), close(), refresh(Object)

refresh

void refresh(java.lang.Object baseClassObject)
             throws ObjectSourceException
Метод делает следующее:

Throws:
DataSourceException - если значение переданного в параметре объекта null или объект не является экземпляром базового класса.
ObjectSourceException
See Also:
setBaseClass(Class), open(), close(), refresh()

close

void close()
           throws ObjectSourceException
Метод закрывает источник данных если тот не находится в состоянии ObjectSource.Mode.CLOSED. После выполнения метода источник объектов переводится в состояние ObjectSource.Mode.CLOSED.

Throws:
ObjectSourceException
See Also:
open(), close(), refresh(), refresh(Object)

addDetailInfo

void addDetailInfo(DetailObjectSourceInfo detailDataSourceInfo)
Метод добавляет информацию об источнике данных который является подчиненным по отношению к данному.

See Also:
#activateDetailConstraints(Object masterObject), deactivateDetailConstraints(), isDetailConstraintsActivated(), getDetailInfos()

getDetailInfos

java.util.Collection<DetailObjectSourceInfo> getDetailInfos()
Метод возвращает информацию об подчиненных источниках данных.

See Also:
#activateDetailConstraints(Object masterObject), deactivateDetailConstraints(), isDetailConstraintsActivated(), #addDetailInfo(DetailDataSourceInfo detailDataSourceInfo)

activateDetailConstraints

void activateDetailConstraints(java.lang.Object masterObject,
                               boolean masterPropertiesOnly)
                               throws ObjectSourceException
Метод устанавливает ограничения на подчиненных источниках данных.

Parameters:
masterObject - объект которой является главным для подчиненных источников данных.
Throws:
ObjectSourceException
See Also:
deactivateDetailConstraints(), isDetailConstraintsActivated(), #addDetailInfo(DetailDataSourceInfo detailDataSourceInfo), getDetailInfos()

deactivateDetailConstraints

void deactivateDetailConstraints()
                                 throws ObjectSourceException
Метод снимает ограничения с подчиненных источников данных.

Throws:
ObjectSourceException
See Also:
#activateDetailConstraints(Object masterObject), isDetailConstraintsActivated(), #addDetailInfo(DetailDataSourceInfo detailDataSourceInfo), getDetailInfos()

isDetailConstraintsActivated

boolean isDetailConstraintsActivated()
Метод вернет TRUE если ограничения на подчиненных источниках данных были установлены, но еще не были сняты.

See Also:
#activateDetailConstraints(Object masterObject), deactivateDetailConstraints(), #addDetailInfo(DetailDataSourceInfo detailDataSourceInfo), getDetailInfos()

addConstraint

void addConstraint(ObjectSourceConstraint constraint)
                   throws ObjectSourceException
Метод добавляет ограничение к источнику данных.

Throws:
ObjectSourceException
See Also:
#removeConstraint(DataSourceConstraint)

removeConstraint

void removeConstraint(ObjectSourceConstraint constraint)
Метод снимает ограничение с источника данных.

See Also:
#addConstraint(DataSourceConstraint)

getRowCount

int getRowCount()
Метод возвращает количество строк в источнике данных на текущий момент

getRowAt

java.lang.Object[] getRowAt(int row)
Метод возвращает строку в указанной позиции

getQuery

Query getQuery()
Метод возвращает запрос, при помощи которого будет получен результирующий набор данных.

setQuery

void setQuery(Query query)
Метод устанавливает запрос, при помощи которого будет получен результирующий набор данных.

getQueryFilter

QueryFilter getQueryFilter()
Метод возвращает фильтр для источника данных.

setQueryFilter

void setQueryFilter(QueryFilter queryFilter)
Метод задает фильтр для источника данных.

getSelectedRows

java.util.Set<java.lang.Integer> getSelectedRows()
Метод возвращает позиции выделенных в источнике данных строк.

getSelectedRowCount

int getSelectedRowCount()
Метод возвращает количество выделенных строк.

hasSelectedRows

boolean hasSelectedRows()
Метод вернет true если в источнике данных есть выделенные строки

See Also:
#selectRowInPage(int), RowSelectionModel.selectRow(int)

getBaseClass

java.lang.Class getBaseClass()
Метод возвращает класс являющийся базовым для источника данных.

See Also:
setBaseClass(Class)

setBaseClass

void setBaseClass(java.lang.Class baseClass)
Метод устанавливает класс являющийся базовым для источника данных. Только объекты базового класса могут редактироваться в источнике данных.

See Also:
setBaseClass(java.lang.Class)

getBaseClassPosition

int getBaseClassPosition()
Метод возвращает позицию базового класса в строке.

See Also:
setBaseClass(Class), #getCurrentPage()

setBaseClassPosition

void setBaseClassPosition(int position)
Метод устанавливает позицию базового класса в строке.

See Also:
setBaseClass(Class), #getCurrentPage()

getBaseClassAlias

java.lang.String getBaseClassAlias()
Метод возвращает alias базового класса в запросе.

createNewRow

void createNewRow()
                  throws ObjectSourceException
Метод создает новую запись в источнике данных, выбирает ее и начинает процесс изменения, вызывая метод beginModification().

Throws:
ObjectSourceException
See Also:
beginModification(), cancelModification(), saveModification(), getSelectedObjectSet()

removeSelectedRows

void removeSelectedRows()
                        throws ObjectSourceException
Метод удаляет выделенные строки в источнике объектов.

Throws:
ObjectSourceException

getSelectedObjectSet

ObjectSet getSelectedObjectSet()
Метод возвращает множество объектов выделенных в текущий момент времени и доступный для редактирования.

Throws:
DataSourceException - если источник данных находится не в режиме редактирования.
See Also:
beginModification(), cancelModification(), saveModification()

beginModification

void beginModification()
                       throws ObjectSourceException
Вызов данного метода перевовит datasource в режим редактирования ObjectSource.Mode.EDIT.

Throws:
ObjectSourceException
See Also:
saveModification(), cancelModification(), getSelectedObjectSet()

saveModification

void saveModification()
                      throws ObjectSourceException
Метод фиксирует изменения произведенные над выделенными строками. После выполнения метода источник данных переходит в тот режим в котором он был перед вызовом метода beginModification()

Throws:
DataSourceException - если произошли ошибки во время фиксации или источник данных не находится в режиме редактирования.
ObjectSourceException
See Also:
beginModification(), cancelModification(), getSelectedObjectSet()

applyModification

void applyModification()
                       throws ObjectSourceException
Метод сохраняет изменения, но не фиксирует их.

Throws:
ObjectSourceException
See Also:
saveModification(), beginModification(), cancelModification(), getSelectedObjectSet()

cancelModification

void cancelModification()
                        throws ObjectSourceException
Метод отменяет изменения произведенные над выделенными строками. После выполнения метода источник данных переходит в тот режим в котором он был перед вызовом метода beginModification()

Throws:
DataSourceException - если произошли ошибки во время отмены или источник данных не находится в режиме редактирования.
ObjectSourceException
See Also:
beginModification(), #savelModification(), getSelectedObjectSet()

isModificationApplied

boolean isModificationApplied()
Метод вернет TRUE если между вызовами методов beginModification() и saveModification() || cancelModification был успешно выполнен метод applyModification.

See Also:
applyModification(), saveModification(), beginModification(), cancelModification(), getSelectedObjectSet()

addListener

void addListener(ObjectSourceListener listener)
Метод добавляет слушателя к источнику объектов.

removeListener

void removeListener(ObjectSourceListener listener)
Метод удаляет слушателя.

getSummaryRow

SummaryRow getSummaryRow()
Метод возвращает стоку содержащую сводную информацию в разрезе строк источника объектов.

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Throws:
java.lang.CloneNotSupportedException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2005-2006 . All Rights Reserved.