org.nuxeo.drive.service.impl

Class AbstractSyncRootFolderItemFactory

java.lang.Object

org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

org.nuxeo.drive.service.impl.AbstractSyncRootFolderItemFactory

All Implemented Interfaces:

FileSystemItemFactory

Direct Known Subclasses:

DefaultSyncRootFolderItemFactory, PermissionSyncRootFactory, UserWorkspaceSyncRootFactory

public abstract class AbstractSyncRootFolderItemFactory
extends AbstractFileSystemItemFactory

Base FileSystemItemFactory for a synchronization root FolderItem.

Author:

Antoine Taillefer

Field Summary

Fields inherited from class org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

name

Constructor Summary

Constructors

Constructor and Description
AbstractSyncRootFolderItemFactory()

Method Summary

Modifier and Type	Method and Description
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted) Force parent using getParentItem(DocumentModel).
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Force parent using getParentItem(DocumentModel).
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) Force parent using getParentItem(DocumentModel).
protected abstract FolderItem	getParentItem(DocumentModel doc) Returns the parent FileSystemItem.
void	handleParameters(Map<String,String> parameters) No parameters by default.
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) The factory considers that a DocumentModel is adaptable as a FileSystemItem if: It is Folderish AND it is not a version nor a proxy AND it is not HiddenInNavigation AND it is not in the "deleted" life cycle state, unless includeDeleted is true AND it is a synchronization root registered for the current user, unless relaxSyncRootConstraint is true

Methods inherited from class org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

adaptDocument, adaptDocument, canHandleFileSystemItemId, exists, getDocumentByFileSystemId, getDocumentById, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItem, getFileSystemItemById, getFileSystemItemById, getName, isFileSystemItem, isFileSystemItem, parseFileSystemId, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSyncRootFolderItemFactory

public AbstractSyncRootFolderItemFactory()

Method Detail

getParentItem

protected abstract FolderItem getParentItem(DocumentModel doc)

Returns the parent FileSystemItem.

handleParameters

public void handleParameters(Map<String,String> parameters)

No parameters by default.

Specified by:

handleParameters in interface FileSystemItemFactory

Specified by:

handleParameters in class AbstractFileSystemItemFactory

isFileSystemItem

public boolean isFileSystemItem(DocumentModel doc,
                                boolean includeDeleted,
                                boolean relaxSyncRootConstraint)

The factory considers that a DocumentModel is adaptable as a FileSystemItem if:

• It is Folderish
• AND it is not a version nor a proxy
• AND it is not HiddenInNavigation
• AND it is not in the "deleted" life cycle state, unless includeDeleted is true
• AND it is a synchronization root registered for the current user, unless relaxSyncRootConstraint is true

Specified by:

isFileSystemItem in interface FileSystemItemFactory

Specified by:

isFileSystemItem in class AbstractFileSystemItemFactory

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                                        boolean includeDeleted)

Force parent using getParentItem(DocumentModel).

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Overrides:

getFileSystemItem in class AbstractFileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean)

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                                        boolean includeDeleted,
                                        boolean relaxSyncRootConstraint)

Force parent using getParentItem(DocumentModel).

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Overrides:

getFileSystemItem in class AbstractFileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean, boolean)

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                                        boolean includeDeleted,
                                        boolean relaxSyncRootConstraint,
                                        boolean getLockInfo)

Force parent using getParentItem(DocumentModel).

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Overrides:

getFileSystemItem in class AbstractFileSystemItemFactory

Returns:

the FileSystemItem or null if the DocumentModel is not adaptable as a FileSystemItem

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean, boolean)