org.nuxeo.ecm.platform.groups.audit.service.acl.data

Class DataProcessor

java.lang.Object

org.nuxeo.ecm.platform.groups.audit.service.acl.data.DataProcessor

All Implemented Interfaces:

IDataProcessor

Direct Known Subclasses:

DataProcessorPaginated, DataProcessorRecursive

public class DataProcessor
extends Object
implements IDataProcessor

Gather various data and statistics about a document tree

Author:

Martin Pernollet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataProcessor.ProcessorStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected AclSummaryExtractor	acl
protected Collection<DocumentSummary>	allDocuments
protected int	documentMinDepth
protected int	documentTreeDepth
protected IContentFilter	filter
protected String	information
protected static org.apache.commons.logging.Log	log
protected int	n
protected SortedSet<String>	permissions
protected DataProcessor.ProcessorStatus	status
protected TicToc	t
protected SortedSet<String>	userAndGroups

Constructor Summary

Constructors

Constructor and Description
DataProcessor(IContentFilter filter)

Method Summary

Modifier and Type	Method and Description
void	analyze(CoreSession session)
void	analyze(CoreSession session, DocumentModel doc, int timeout)
protected int	computeDepth(DocumentModel m)
protected void	computeGlobalAclSummary(DocumentModel doc) store set of users and set of permission types
protected DocumentSummary	computeSummary(DocumentModel doc) Extract usefull document information for report rendering
protected void	doAnalyze(CoreSession session, DocumentModel root, int timeout)
Collection<DocumentSummary>	getAllDocuments() Ranked so that appear like a tree.
int	getDocumentTreeMaxDepth() The maximum doc tree depth
int	getDocumentTreeMinDepth() The minimum doc tree depth, 0 if analysis was run on repository root, >0 if the analysis was run on a child document of repository root.
String	getInformation() Some text information related to the status
int	getNumberOfDocuments()
Set<String>	getPermissions()
DataProcessor.ProcessorStatus	getStatus() A status concerning data analysis
Set<String>	getUserAndGroups()
void	init()
protected void	initSummarySet()
void	log()
protected void	processDocument(DocumentModel doc) Extract relevant information from document model, to only keep a DocumentSummary and a few general informations about the document repository.
protected int	updateTreeSize(DocumentSummary da) report global tree size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

documentMinDepth

protected int documentMinDepth

documentTreeDepth

protected int documentTreeDepth

userAndGroups

protected SortedSet<String> userAndGroups

permissions

protected SortedSet<String> permissions

status

protected DataProcessor.ProcessorStatus status

information

protected String information

allDocuments

protected Collection<DocumentSummary> allDocuments

filter

protected IContentFilter filter

acl

protected AclSummaryExtractor acl

n

protected int n

t

protected TicToc t

Constructor Detail

DataProcessor

public DataProcessor(IContentFilter filter)

Method Detail

analyze

public void analyze(CoreSession session)
             throws ClientException

Specified by:

analyze in interface IDataProcessor

Throws:

ClientException

analyze

public void analyze(CoreSession session,
                    DocumentModel doc,
                    int timeout)
             throws ClientException

Specified by:

analyze in interface IDataProcessor

Throws:

ClientException

init

public void init()

doAnalyze

protected void doAnalyze(CoreSession session,
                         DocumentModel root,
                         int timeout)
                  throws ClientException

Throws:

ClientException

initSummarySet

protected void initSummarySet()

processDocument

protected void processDocument(DocumentModel doc)
                        throws ClientException

Extract relevant information from document model, to only keep a DocumentSummary and a few general informations about the document repository.

Throws:

ClientException

computeSummary

protected DocumentSummary computeSummary(DocumentModel doc)
                                  throws ClientException

Extract usefull document information for report rendering

Throws:

ClientException

computeDepth

protected int computeDepth(DocumentModel m)

updateTreeSize

protected int updateTreeSize(DocumentSummary da)

report global tree size

computeGlobalAclSummary

protected void computeGlobalAclSummary(DocumentModel doc)
                                throws ClientException

store set of users and set of permission types

Throws:

ClientException

getAllDocuments

public Collection<DocumentSummary> getAllDocuments()

Ranked so that appear like a tree.

Specified by:

getAllDocuments in interface IDataProcessor

getUserAndGroups

public Set<String> getUserAndGroups()

Specified by:

getUserAndGroups in interface IDataProcessor

getPermissions

public Set<String> getPermissions()

Specified by:

getPermissions in interface IDataProcessor

getDocumentTreeMaxDepth

public int getDocumentTreeMaxDepth()

Description copied from interface: IDataProcessor

The maximum doc tree depth

Specified by:

getDocumentTreeMaxDepth in interface IDataProcessor

getDocumentTreeMinDepth

public int getDocumentTreeMinDepth()

Description copied from interface: IDataProcessor

The minimum doc tree depth, 0 if analysis was run on repository root, >0 if the analysis was run on a child document of repository root.

Specified by:

getDocumentTreeMinDepth in interface IDataProcessor

getNumberOfDocuments

public int getNumberOfDocuments()

Specified by:

getNumberOfDocuments in interface IDataProcessor

getStatus

public DataProcessor.ProcessorStatus getStatus()

Description copied from interface: IDataProcessor

A status concerning data analysis

Specified by:

getStatus in interface IDataProcessor

getInformation

public String getInformation()

Description copied from interface: IDataProcessor

Some text information related to the status

Specified by:

getInformation in interface IDataProcessor

log

public void log()