org.nuxeo.drive.service.impl

Class AbstractFileSystemItemFactory

java.lang.Object

org.nuxeo.drive.service.impl.AbstractFileSystemItemFactory

All Implemented Interfaces:

FileSystemItemFactory

Direct Known Subclasses:

AbstractSyncRootFolderItemFactory, DefaultFileSystemItemFactory, UserSyncRootParentFactory, UserWorkspaceTopLevelFactory

public abstract class AbstractFileSystemItemFactory
extends Object
implements FileSystemItemFactory

Base class for FileSystemItemFactory implementers. It is DocumentModel backed.

Author:

Antoine Taillefer

See Also:

DefaultFileSystemItemFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name

Constructor Summary

Constructors

Constructor and Description
AbstractFileSystemItemFactory()

Method Summary

Modifier and Type	Method and Description
protected FileSystemItem	adaptDocument(DocumentModel doc, boolean forceParentItem, FolderItem parentItem)
protected abstract FileSystemItem	adaptDocument(DocumentModel doc, boolean forceParentItem, FolderItem parentItem, boolean relaxSyncRootConstraint, boolean getLockInfo) Adapts the given DocumentModel to a FileSystemItem.
boolean	canHandleFileSystemItemId(String id) Returns true if the given FileSystemItem id can be handled by this factory.
boolean	exists(String id, NuxeoPrincipal principal) The default factory considers that a FileSystemItem with the given id exists if the backing DocumentModel can be fetched and isFileSystemItem(DocumentModel) returns true.
protected DocumentModel	getDocumentById(String docId, CoreSession session)
FileSystemItem	getFileSystemItem(DocumentModel doc) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel.
FileSystemItem	getFileSystemItem(DocumentModel doc, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) Gets the FileSystemItem for the given DocumentModel.
protected FileSystemItem	getFileSystemItem(DocumentModel doc, boolean forceParentItem, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo)
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem) Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted) Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint) Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.
FileSystemItem	getFileSystemItem(DocumentModel doc, FolderItem parentItem, boolean includeDeleted, boolean relaxSyncRootConstraint, boolean getLockInfo) Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.
FileSystemItem	getFileSystemItemById(String id, NuxeoPrincipal principal) Gets the FileSystemItem with the given id using a core session fetched with the given principal.
FileSystemItem	getFileSystemItemById(String id, String parentId, NuxeoPrincipal principal) Gets the FileSystemItem with the given id and parent id using a core session fetched with the given principal.
String	getName() Gets the factory unique name.
boolean	isFileSystemItem(DocumentModel doc) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
boolean	isFileSystemItem(DocumentModel doc, boolean includeDeleted) Returns true if the given DocumentModel is adaptable as a FileSystemItem.
protected String[]	parseFileSystemId(String id)
void	setName(String name) Sets the factory unique name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.drive.service.FileSystemItemFactory

handleParameters, isFileSystemItem

Field Detail

name

protected String name

Constructor Detail

AbstractFileSystemItemFactory

public AbstractFileSystemItemFactory()

Method Detail

adaptDocument

protected abstract FileSystemItem adaptDocument(DocumentModel doc,
                                                boolean forceParentItem,
                                                FolderItem parentItem,
                                                boolean relaxSyncRootConstraint,
                                                boolean getLockInfo)

Adapts the given DocumentModel to a FileSystemItem.

See Also:

getFileSystemItem(DocumentModel, boolean, FolderItem, boolean, boolean, boolean)

getName

public String getName()

Description copied from interface: FileSystemItemFactory

Gets the factory unique name.

Specified by:

getName in interface FileSystemItemFactory

setName

public void setName(String name)

Description copied from interface: FileSystemItemFactory

Sets the factory unique name.

Specified by:

setName in interface FileSystemItemFactory

isFileSystemItem

public boolean isFileSystemItem(DocumentModel doc)

Description copied from interface: FileSystemItemFactory

Returns true if the given DocumentModel is adaptable as a FileSystemItem.

Specified by:

isFileSystemItem in interface FileSystemItemFactory

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel, boolean)

isFileSystemItem

public boolean isFileSystemItem(DocumentModel doc,
                                boolean includeDeleted)

Description copied from interface: FileSystemItemFactory

Returns true if the given DocumentModel is adaptable as a FileSystemItem. If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns false.

Specified by:

isFileSystemItem in interface FileSystemItemFactory

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc)

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

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

See Also:

FileSystemItemFactory.isFileSystemItem(DocumentModel), FileSystemItemFactory.getFileSystemItem(DocumentModel, boolean)

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                                        boolean includeDeleted)

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel. If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in the trash it is not considered as adaptable as a FileSystemItem, thus the method returns null.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

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)

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel.

If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns null.

If relaxSyncRootConstraint is true no filter is applied on the synchronization root aspect for the current user.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

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)

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel.

If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns null.

If relaxSyncRootConstraint is true no filter is applied on the synchronization root aspect for the current user.

If getLockInfo is true the Lock is fetched from the DocumentModel and set on the returned FileSystemItem.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

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,
                                        FolderItem parentItem)

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

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

See Also:

FileSystemItemFactory.getFileSystemItem(DocumentModel, FolderItem, boolean)

getFileSystemItem

public FileSystemItem getFileSystemItem(DocumentModel doc,
                                        FolderItem parentItem,
                                        boolean includeDeleted)

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem. If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in the trash it is not considered as adaptable as a FileSystemItem, thus the method returns null.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

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

getFileSystemItem

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

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.

If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns null.

If relaxSyncRootConstraint is true no filter is applied on the synchronization root aspect for the current user.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

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

getFileSystemItem

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

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem for the given DocumentModel forcing its parent with the given parentItem.

If includeDeleted is true no filter is applied on the "trashed" state, else if the document is in this state it is not considered as adaptable as a FileSystemItem, thus the method returns null.

If relaxSyncRootConstraint is true no filter is applied on the synchronization root aspect for the current user.

If getLockInfo is true the Lock is fetched from the DocumentModel and set on the returned FileSystemItem.

Specified by:

getFileSystemItem in interface FileSystemItemFactory

Returns:

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

canHandleFileSystemItemId

public boolean canHandleFileSystemItemId(String id)

Description copied from interface: FileSystemItemFactory

Returns true if the given FileSystemItem id can be handled by this factory. It is typically the case when the factory has been responsible for generating the FileSystemItem.

Specified by:

canHandleFileSystemItemId in interface FileSystemItemFactory

exists

public boolean exists(String id,
                      NuxeoPrincipal principal)

The default factory considers that a FileSystemItem with the given id exists if the backing DocumentModel can be fetched and isFileSystemItem(DocumentModel) returns true.

Specified by:

exists in interface FileSystemItemFactory

See Also:

isFileSystemItem(DocumentModel)

getFileSystemItemById

public FileSystemItem getFileSystemItemById(String id,
                                            NuxeoPrincipal principal)

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem with the given id using a core session fetched with the given principal.

Specified by:

getFileSystemItemById in interface FileSystemItemFactory

Returns:

the FileSystemItem or null if none matches the given id

getFileSystemItemById

public FileSystemItem getFileSystemItemById(String id,
                                            String parentId,
                                            NuxeoPrincipal principal)

Description copied from interface: FileSystemItemFactory

Gets the FileSystemItem with the given id and parent id using a core session fetched with the given principal.

Specified by:

getFileSystemItemById in interface FileSystemItemFactory

Returns:

the FileSystemItem or null if none matches the given id and parent id

adaptDocument

protected FileSystemItem adaptDocument(DocumentModel doc,
                                       boolean forceParentItem,
                                       FolderItem parentItem)

getFileSystemItem

protected FileSystemItem getFileSystemItem(DocumentModel doc,
                                           boolean forceParentItem,
                                           FolderItem parentItem,
                                           boolean includeDeleted,
                                           boolean relaxSyncRootConstraint,
                                           boolean getLockInfo)

parseFileSystemId

protected String[] parseFileSystemId(String id)

getDocumentById

protected DocumentModel getDocumentById(String docId,
                                        CoreSession session)