org.nuxeo.ecm.core.utils

Class BlobsExtractor

java.lang.Object

org.nuxeo.ecm.core.utils.BlobsExtractor

public class BlobsExtractor
extends Object

Extractor for all the blobs of a document.

Author:

Florent Guillaume, Benjamin Jalon

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Map<String,List<String>>>	blobFieldPaths
protected List<String>	docTypeCached
protected static org.apache.commons.logging.Log	log
protected SchemaManager	schemaManager

Constructor Summary

Constructors

Constructor and Description
BlobsExtractor()

Method Summary

Modifier and Type	Method and Description
protected void	blobMatched(DocumentType docType, Schema schema, String path, Field field) Call during the parsing of the schema structure in findInteresting(org.nuxeo.ecm.core.schema.DocumentType, org.nuxeo.ecm.core.schema.types.Schema, java.lang.String, org.nuxeo.ecm.core.schema.types.ComplexType) if field is a Blob Type.
protected void	containsBlob(DocumentType docType, Schema schema, String path, Field field) Called during the parsing of the schema structure in findInteresting(org.nuxeo.ecm.core.schema.DocumentType, org.nuxeo.ecm.core.schema.types.Schema, java.lang.String, org.nuxeo.ecm.core.schema.types.ComplexType) if field contains a subfield of type Blob.
protected void	createCacheForDocumentType(DocumentType docType)
protected boolean	findInteresting(DocumentType docType, Schema schema, String path, ComplexType ct) Analyzes the document's schemas to find which fields and complex types contain blobs.
Map<String,List<String>>	getBlobFieldPathForDocumentType(String documentType) Get path list of properties that may contain a blob for the given document type.
List<Blob>	getBlobs(DocumentModel doc) Finds all the blobs of the document.
List<Property>	getBlobsProperties(DocumentModel doc) Get properties of the given document that contain a blob value.
protected void	getBlobValue(Property prop, List<String> subPath, String completePath, List<Property> result)
protected SchemaManager	getSchemaManager()
void	invalidateCache()
void	invalidateDocumentTypeCache(String docType)
void	setExtractorProperties(Set<String> pathProps, Set<String> excludedPathProps, boolean indexBlobs)

Methods inherited from class java.lang.Object

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

Field Detail

log

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

blobFieldPaths

protected final Map<String,Map<String,List<String>>> blobFieldPaths

docTypeCached

protected List<String> docTypeCached

schemaManager

protected SchemaManager schemaManager

Constructor Detail

BlobsExtractor

public BlobsExtractor()

Method Detail

getSchemaManager

protected SchemaManager getSchemaManager()

getBlobsProperties

public List<Property> getBlobsProperties(DocumentModel doc)

Get properties of the given document that contain a blob value. This method uses the cache engine to find these properties.

getBlobFieldPathForDocumentType

public Map<String,List<String>> getBlobFieldPathForDocumentType(String documentType)

Get path list of properties that may contain a blob for the given document type.

Parameters:

documentType - document type name

Returns:

return the property names that contain blob

invalidateDocumentTypeCache

public void invalidateDocumentTypeCache(String docType)

invalidateCache

public void invalidateCache()

createCacheForDocumentType

protected void createCacheForDocumentType(DocumentType docType)

findInteresting

protected boolean findInteresting(DocumentType docType,
                                  Schema schema,
                                  String path,
                                  ComplexType ct)

Analyzes the document's schemas to find which fields and complex types contain blobs. For each blob fields type found, blobMatched(DocumentType, Schema, String, Field) is called and for each property that contains a subProperty containing a Blob, containsBlob(DocumentType, Schema, String, Field) is called

Parameters:

schema - The parent schema that contains the field

ct - Current type parsed

Returns:

true if the passed complex type contains at least one blob field

blobMatched

protected void blobMatched(DocumentType docType,
                           Schema schema,
                           String path,
                           Field field)

Call during the parsing of the schema structure in findInteresting(org.nuxeo.ecm.core.schema.DocumentType, org.nuxeo.ecm.core.schema.types.Schema, java.lang.String, org.nuxeo.ecm.core.schema.types.ComplexType) if field is a Blob Type. This method stores the path to that Field.

Parameters:

schema - The parent schema that contains the field

field - Field that is a BlobType

containsBlob

protected void containsBlob(DocumentType docType,
                            Schema schema,
                            String path,
                            Field field)

Called during the parsing of the schema structure in findInteresting(org.nuxeo.ecm.core.schema.DocumentType, org.nuxeo.ecm.core.schema.types.Schema, java.lang.String, org.nuxeo.ecm.core.schema.types.ComplexType) if field contains a subfield of type Blob. This method does nothing.

Parameters:

schema - The parent schema that contains the field

field - Field that contains a subField of type BlobType

getBlobValue

protected void getBlobValue(Property prop,
                            List<String> subPath,
                            String completePath,
                            List<Property> result)

getBlobs

public List<Blob> getBlobs(DocumentModel doc)

Finds all the blobs of the document.

This method is not thread-safe.

Parameters:

doc - the document

Returns:

the list of blobs in the document

setExtractorProperties

public void setExtractorProperties(Set<String> pathProps,
                                   Set<String> excludedPathProps,
                                   boolean indexBlobs)