|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object lumis.portal.serialization.BaseSerializationContext
public class BaseSerializationContext
Base class for Serialization Context classes
Constructor Summary | |
---|---|
BaseSerializationContext(SessionConfig sessionConfig,
ITransaction transaction,
String rootChannelId,
IDirectory directory,
boolean progressEnabled,
boolean includeContent)
|
Method Summary | |
---|---|
String |
getCurrentChannelPath()
|
ISerializer |
getDefaultSerializer()
Returns the default object serializer for this serialization context. |
IDirectory |
getDirectory()
|
Set<String> |
getGlobalGroups()
Returns the global groups for serializing. |
boolean |
getIncludeContent()
|
int |
getItemProgressMax()
|
int |
getItemProgressValue()
|
int |
getOverallProgressMax()
|
int |
getOverallProgressValue()
|
String |
getProcessId()
|
boolean |
getProgressEnabled()
|
IResource |
getResource()
|
String |
getRootChannelId()
|
SerializationSettings |
getSerializationSettings()
|
SessionConfig |
getSessionConfig()
|
long |
getStartTime()
|
ITransaction |
getTransaction()
|
void |
incrementItemProgressValue(int increment)
|
void |
incrementOverallProgressValue(int increment)
|
boolean |
isShallowSerialization()
Returns whether the serialization is recursive or not. |
void |
logDebug(String msg)
|
void |
logDebug(String msg,
Object o)
|
void |
logDebug(String msg,
Throwable t)
|
void |
sendProgressFinalNotification(String message,
ProgressConfig.Type type)
|
void |
sendProgressNotification(Document messageDoc,
String styleFilename,
ProgressConfig.Type type)
|
void |
sendProgressNotification(String message,
ProgressConfig.Type type,
String innerProgressId)
|
void |
setCurrentChannelPath(String currentChannelPath)
|
void |
setDefaultSerializer(ISerializer defaultSerializer)
Sets the default object serializer for this serialization context. |
void |
setDirectory(IDirectory directory)
|
void |
setItemProgressMax(int itemProgressMax)
|
void |
setItemProgressValue(int itemProgressValue)
|
void |
setOverallProgressMax(int overallProgressMax)
|
void |
setOverallProgressValue(int overallProgressValue)
|
void |
setProcessId(String processId)
|
void |
setRootChannelId(String rootChannelId)
|
void |
setSerializationSettings(SerializationSettings serializationSettings)
|
protected void |
setShallowSerialization(boolean shallowSerialization)
Sets whether the serialization will serialize the structure recursively or not. |
void |
setStartTime(long startTimeMillis)
|
void |
setTransaction(ITransaction transaction)
|
void |
updateProgressBar(int incrementOverallProgress,
int incrementItemProgress,
String itemName)
|
void |
updateProgressBar(int incrementOverallProgress,
String itemName)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseSerializationContext(SessionConfig sessionConfig, ITransaction transaction, String rootChannelId, IDirectory directory, boolean progressEnabled, boolean includeContent)
Method Detail |
---|
public Set<String> getGlobalGroups()
public SerializationSettings getSerializationSettings()
public void setSerializationSettings(SerializationSettings serializationSettings)
public String getRootChannelId()
public void setRootChannelId(String rootChannelId)
public IDirectory getDirectory()
public void setDirectory(IDirectory directory)
public SessionConfig getSessionConfig()
public void setTransaction(ITransaction transaction)
public ITransaction getTransaction()
public IResource getResource()
public String getProcessId()
public void setProcessId(String processId)
public int getItemProgressMax()
public void setItemProgressMax(int itemProgressMax)
public int getItemProgressValue()
public void setItemProgressValue(int itemProgressValue)
public void incrementItemProgressValue(int increment)
public int getOverallProgressMax()
public void setOverallProgressMax(int overallProgressMax)
public void incrementOverallProgressValue(int increment)
public int getOverallProgressValue()
public void setOverallProgressValue(int overallProgressValue)
public long getStartTime()
public void setStartTime(long startTimeMillis)
public boolean getIncludeContent()
public boolean getProgressEnabled()
public void updateProgressBar(int incrementOverallProgress, String itemName) throws PortalException
PortalException
public void updateProgressBar(int incrementOverallProgress, int incrementItemProgress, String itemName) throws PortalException
PortalException
public void sendProgressNotification(String message, ProgressConfig.Type type, String innerProgressId) throws PortalException
PortalException
public void sendProgressNotification(Document messageDoc, String styleFilename, ProgressConfig.Type type) throws PortalException
PortalException
public void sendProgressFinalNotification(String message, ProgressConfig.Type type) throws PortalException
PortalException
public String getCurrentChannelPath()
public void setCurrentChannelPath(String currentChannelPath)
public void logDebug(String msg)
public void logDebug(String msg, Object o)
public void logDebug(String msg, Throwable t)
public ISerializer getDefaultSerializer()
public void setDefaultSerializer(ISerializer defaultSerializer)
defaultSerializer
- the defaultSerializer value to set.protected void setShallowSerialization(boolean shallowSerialization)
isShallowSerialization()
for more details on recursion implications.
shallowSerialization
- the shallow serialization value.public boolean isShallowSerialization()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |