org.nuxeo.ecm.platform.filemanager.service.extension

Class NoteImporter

java.lang.Object

org.nuxeo.ecm.platform.filemanager.service.extension.AbstractFileImporter

org.nuxeo.ecm.platform.filemanager.service.extension.NoteImporter

All Implemented Interfaces:

Serializable, Comparable<FileImporter>, FileImporter

public class NoteImporter
extends AbstractFileImporter

Imports the string content of a blob as text for the content of the "note" field of a new Note document.

If an existing document with the same title is found the existing Note document is updated instead.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.nuxeo.ecm.platform.filemanager.service.extension.AbstractFileImporter

DISABLE_AUDIT_LOGGER, docType, enabled, fileManagerService, filters, name, order, patterns, SKIP_UPDATE_AUDIT_LOGGING

Constructor Summary

Constructors

Constructor and Description
NoteImporter()

Method Summary

Modifier and Type	Method and Description
String	getDefaultDocType() Default document type to use when the plugin XML configuration does not specify one.
protected String	getString(Blob blob)
protected static String	guessEncoding(Blob blob)
boolean	isOverwriteByTitle() Whether document overwrite is detected by checking title or filename.
void	updateDocument(DocumentModel doc, Blob content) Updates the document (sets its properties).
boolean	updateDocumentIfPossible(DocumentModel doc, Blob content) Tries to update the document doc with the blob content.

Methods inherited from class org.nuxeo.ecm.platform.filemanager.service.extension.AbstractFileImporter

checkIn, checkInAfterAdd, compareTo, create, createDocument, doSecurityCheck, getBlob, getDocType, getDocType, getFileManagerService, getFilters, getName, getNearestContainerPath, getOrder, isEnabled, matches, setDocType, setEnabled, setFileManagerService, setFilters, setName, setOrder, skipCheckInForBlob

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteImporter

public NoteImporter()

Method Detail

getDefaultDocType

public String getDefaultDocType()

Description copied from class: AbstractFileImporter

Default document type to use when the plugin XML configuration does not specify one.

To implement when the default AbstractFileImporter.create(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.api.Blob, java.lang.String, boolean, java.lang.String, org.nuxeo.ecm.platform.types.TypeManager) method is used.

Overrides:

getDefaultDocType in class AbstractFileImporter

isOverwriteByTitle

public boolean isOverwriteByTitle()

Description copied from class: AbstractFileImporter

Whether document overwrite is detected by checking title or filename.

To implement when the default AbstractFileImporter.create(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.api.Blob, java.lang.String, boolean, java.lang.String, org.nuxeo.ecm.platform.types.TypeManager) method is used.

Overrides:

isOverwriteByTitle in class AbstractFileImporter

updateDocumentIfPossible

public boolean updateDocumentIfPossible(DocumentModel doc,
                                        Blob content)

Description copied from class: AbstractFileImporter

Tries to update the document doc with the blob content.

Returns true if the document is really updated.

Overrides:

updateDocumentIfPossible in class AbstractFileImporter

updateDocument

public void updateDocument(DocumentModel doc,
                           Blob content)

Description copied from class: AbstractFileImporter

Updates the document (sets its properties).

Default implementation sets the content.

Overrides:

updateDocument in class AbstractFileImporter

getString

protected String getString(Blob blob)
                    throws IOException

Throws:

IOException

guessEncoding

protected static String guessEncoding(Blob blob)
                               throws IOException

Throws:

IOException