Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.objectstyle.cayenne.dataport
Interface DataPortDelegate  view DataPortDelegate download DataPortDelegate.java


public interface DataPortDelegate

Interface for callback and delegate methods allowing implementing classes to control various aspects of data porting via DataPort. DataPort instance will invoke appropriate delegate methods during different stages of porting process.


Method Summary
 void didCleanData(DataPort portTool, org.objectstyle.cayenne.map.DbEntity entity, int rowCount)
          Invoked by DataPort right after the end of data cleanup for a given entity.
 void didPortEntity(DataPort portTool, org.objectstyle.cayenne.map.DbEntity entity, int rowCount)
          Invoked by DataPort right after the end of data port for a given entity.
 void willCleanData(DataPort portTool, org.objectstyle.cayenne.map.DbEntity entity, org.objectstyle.cayenne.query.Query query)
          Invoked by DataPort right before the start of data cleanup for a given entity.
 java.util.List willCleanData(DataPort portTool, java.util.List entities)
          Allows delegate to sort or otherwise alter a list of DbEntities right before data cleanup starts.
 java.util.List willPortEntities(DataPort portTool, java.util.List entities)
          Allows delegate to sort or otherwise alter a list of DbEntities right before the port starts.
 void willPortEntity(DataPort portTool, org.objectstyle.cayenne.map.DbEntity entity, org.objectstyle.cayenne.query.Query query)
          Invoked by DataPort right before the start of data port for a given entity.
 

Method Detail

willPortEntities

public java.util.List willPortEntities(DataPort portTool,
                                       java.util.List entities)
Allows delegate to sort or otherwise alter a list of DbEntities right before the port starts.


willPortEntity

public void willPortEntity(DataPort portTool,
                           org.objectstyle.cayenne.map.DbEntity entity,
                           org.objectstyle.cayenne.query.Query query)
Invoked by DataPort right before the start of data port for a given entity. Allows delegate to handle such things like logging, etc. Also makes it possible to alter the select query used to cleanup the data, e.g. set a limiting qualifier.


didPortEntity

public void didPortEntity(DataPort portTool,
                          org.objectstyle.cayenne.map.DbEntity entity,
                          int rowCount)
Invoked by DataPort right after the end of data port for a given entity. Allows delegate to handle such things like logging, etc.


willCleanData

public java.util.List willCleanData(DataPort portTool,
                                    java.util.List entities)
Allows delegate to sort or otherwise alter a list of DbEntities right before data cleanup starts.


willCleanData

public void willCleanData(DataPort portTool,
                          org.objectstyle.cayenne.map.DbEntity entity,
                          org.objectstyle.cayenne.query.Query query)
Invoked by DataPort right before the start of data cleanup for a given entity. Allows delegate to handle such things like logging, etc. Also makes it possible to alter the delete query used to cleanup the data, e.g. set a limiting qualifier.


didCleanData

public void didCleanData(DataPort portTool,
                         org.objectstyle.cayenne.map.DbEntity entity,
                         int rowCount)
Invoked by DataPort right after the end of data cleanup for a given entity. Allows delegate to handle such things like logging, etc.