mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-16 17:55:15 +00:00
20068f981b
The code changes were pulled from the fix branch and V1.4 (HIBERNATE_UPGRADE 5207 5293) The jars were manually dropped in again due to the new directory structure git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5303 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
104 lines
4.2 KiB
Java
104 lines
4.2 KiB
Java
/*
|
|
* Copyright (C) 2005 Jesper Steen Møller
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.repo.content.metadata;
|
|
|
|
import java.io.Serializable;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.service.cmr.repository.ContentIOException;
|
|
import org.alfresco.service.cmr.repository.ContentReader;
|
|
import org.alfresco.service.namespace.QName;
|
|
|
|
/**
|
|
* Interface for document property extracters.
|
|
*
|
|
* @author Jesper Steen Møller
|
|
* @author Derek Hulley
|
|
*/
|
|
public interface MetadataExtracter
|
|
{
|
|
/**
|
|
* Provides the approximate accuracy with which this extracter can extract
|
|
* metadata for the mimetype.
|
|
* <p>
|
|
*
|
|
* @param sourceMimetype the source mimetype
|
|
* @return Returns a score 0.0 to 1.0. 0.0 indicates that the extraction
|
|
* cannot be performed at all. 1.0 indicates that the extraction can
|
|
* be performed perfectly.
|
|
*/
|
|
public double getReliability(String sourceMimetype);
|
|
|
|
/**
|
|
* Provides an estimate, usually a worst case guess, of how long an
|
|
* extraction will take.
|
|
* <p>
|
|
* This method is used to determine, up front, which of a set of equally
|
|
* reliant transformers will be used for a specific extraction.
|
|
*
|
|
* @return Returns the approximate number of milliseconds per transformation
|
|
*/
|
|
public long getExtractionTime();
|
|
|
|
/**
|
|
* Extracts the metadata from the content provided by the reader and source
|
|
* mimetype to the supplied map.
|
|
* <p>
|
|
* The extraction viability can be determined by an up front call to
|
|
* {@link #getReliability(String)}.
|
|
* <p>
|
|
* The source mimetype <b>must</b> be available on the
|
|
* {@link org.alfresco.service.cmr.repository.ContentAccessor#getMimetype()} method
|
|
* of the reader.
|
|
* <p>
|
|
* <b>Note:</b> Internally, the extracter may need to perform a mapping of document-specific
|
|
* properties to <code>QName</code>. This is an implementation detail that is
|
|
* supported in the default abstract implementations.
|
|
*
|
|
* @param reader the source of the content
|
|
* @param destination the map of properties to populate (essentially a return value)
|
|
* @throws ContentIOException if a detectable error occurs
|
|
*
|
|
* @see #extract(ContentReader, Map, Map)
|
|
*/
|
|
public void extract(ContentReader reader, Map<QName, Serializable> destination) throws ContentIOException;
|
|
|
|
/**
|
|
*
|
|
*
|
|
* @param reader the source of the content
|
|
* @param destination the map of properties to populate (essentially a return value)
|
|
* @param propertyMapping a mapping of internal (document-specific properties) to system
|
|
* properties.
|
|
* @throws ContentIOException if a detectable error occurs
|
|
*
|
|
* @see #extract(ContentReader, Map)
|
|
*/
|
|
public void extract(
|
|
ContentReader reader,
|
|
Map<QName, Serializable> destination,
|
|
Map<String, QName> propertyMapping) throws ContentIOException;
|
|
}
|