Package org.opencms.db.userpublishlist
Class A_CmsLogPublishListConverter
- java.lang.Object
-
- org.opencms.db.userpublishlist.A_CmsLogPublishListConverter
-
- Direct Known Subclasses:
CmsLogPublishListConverterAllUsers
,CmsLogPublishListConverterCurrentUser
public abstract class A_CmsLogPublishListConverter extends java.lang.Object
Abstract base class used for converting from CmsLogEntry instances to the necessary changes in the user's publish list.Multiple log entries can be added via the add() method, and then all changes to the database are performed when the writeToDatabase() method is called.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map<CmsUUID,CmsPublishListResourceState>
m_entries
Map from structure ids to publish list state objects.
-
Constructor Summary
Constructors Constructor Description A_CmsLogPublishListConverter()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
add(CmsLogEntry entry)
Processes a log entry.CmsPublishListResourceState
getEntry(CmsUUID key)
Gets the state entry for the given structure id, creating it if it doesn't already exist.void
writeChangesToDatabase(CmsDbContext dbc, I_CmsProjectDriver projectDriver)
Writes the collected changes to the database.
-
-
-
Field Detail
-
m_entries
protected java.util.Map<CmsUUID,CmsPublishListResourceState> m_entries
Map from structure ids to publish list state objects.
-
-
Constructor Detail
-
A_CmsLogPublishListConverter
public A_CmsLogPublishListConverter()
-
-
Method Detail
-
add
public abstract void add(CmsLogEntry entry)
Processes a log entry.- Parameters:
entry
- the entry to process
-
getEntry
public CmsPublishListResourceState getEntry(CmsUUID key)
Gets the state entry for the given structure id, creating it if it doesn't already exist.- Parameters:
key
- the structure id of a resource- Returns:
- the state object for the structure id
-
writeChangesToDatabase
public void writeChangesToDatabase(CmsDbContext dbc, I_CmsProjectDriver projectDriver) throws CmsDataAccessException
Writes the collected changes to the database.- Parameters:
dbc
- the database contextprojectDriver
- the project driver- Throws:
CmsDataAccessException
- if something goes wrong
-
-