Package org.opencastproject.textanalyzer.impl

Class TextAnalyzerServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.textanalyzer.impl.TextAnalyzerServiceImpl

All Implemented Interfaces:

JobProducer, TextAnalyzerService, org.osgi.service.cm.ManagedService

public class TextAnalyzerServiceImpl
extends AbstractJobProducer
implements TextAnalyzerService, org.osgi.service.cm.ManagedService

Media analysis service that takes takes an image and returns text as extracted from that image.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANALYSIS_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_ANALYSIS_JOB_LOAD
static final String	COLLECTION_ID	Resulting collection in the working file repository
static final float	DEFAULT_ANALYSIS_JOB_LOAD	The approximate load placed on the system by creating a text analysis job
protected DictionaryService	dictionaryService	The dictionary service
protected Mpeg7CatalogService	mpeg7CatalogService	The mpeg-7 service
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
protected SecurityService	securityService	The security service
protected UserDirectoryService	userDirectoryService	The user directory service

Fields inherited from class org.opencastproject.job.api.AbstractJobProducer

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY, acceptJobLoadsExeedingMaxLoad, DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING, executor, jobType

Fields inherited from interface org.opencastproject.textanalyzer.api.TextAnalyzerService

JOB_TYPE, OPERATION

Constructor Summary

Constructors

Constructor	Description
TextAnalyzerServiceImpl()	Creates a new instance of the text analyzer service.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGi callback on component activation.
protected VideoText[]	analyze(File imageFile, String id)	Returns the video text element for the given image.
Job	extract(Attachment image)	Takes the given image and returns a receipt that can be used to get the resulting catalog.
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
protected SecurityService	getSecurityService()	Returns a reference to the security service
protected ServiceRegistry	getServiceRegistry()	Returns a reference to the service registry.
protected UserDirectoryService	getUserDirectoryService()	Returns a reference to the user directory service
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
protected void	setDictionaryService(DictionaryService dictionaryService)	Sets the dictionary service
protected void	setMpeg7CatalogService(Mpeg7CatalogService mpeg7CatalogService)	Sets the mpeg7CatalogService
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setReadinessIndicator(ReadinessIndicator readinessIndicator)
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
protected void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the receipt service
protected void	setTextExtractor(TextExtractor textExtractor)	Sets the text extractor.
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
protected void	setWorkspace(Workspace workspace)	Sets the workspace
void	updated(Dictionary properties)

Methods inherited from class org.opencastproject.job.api.AbstractJobProducer

acceptJob, countJobs, finallyUpdateJob, getJobType, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

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

Field Details

COLLECTION_ID

public static final String COLLECTION_ID

Resulting collection in the working file repository

See Also:

• Constant Field Values

DEFAULT_ANALYSIS_JOB_LOAD

public static final float DEFAULT_ANALYSIS_JOB_LOAD

The approximate load placed on the system by creating a text analysis job

See Also:

• Constant Field Values

ANALYSIS_JOB_LOAD_KEY

public static final String ANALYSIS_JOB_LOAD_KEY

The key to look for in the service configuration file to override the DEFAULT_ANALYSIS_JOB_LOAD

See Also:

• Constant Field Values

mpeg7CatalogService

protected Mpeg7CatalogService mpeg7CatalogService

The mpeg-7 service

dictionaryService

protected DictionaryService dictionaryService

The dictionary service

securityService

protected SecurityService securityService

The security service

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

Constructor Details

TextAnalyzerServiceImpl

public TextAnalyzerServiceImpl()

Creates a new instance of the text analyzer service.

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext cc)

OSGi callback on component activation.

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - the component context

extract

public Job extract(Attachment image)
            throws TextAnalyzerException,
MediaPackageException

Takes the given image and returns a receipt that can be used to get the resulting catalog.

Specified by:

extract in interface TextAnalyzerService

Parameters:

image - element to analyze

Returns:

the metadata

Throws:

TextAnalyzerException - if the text in this image can not be analyzed

MediaPackageException - if this attachment is not valid

See Also:

• TextAnalyzerService.extract(org.opencastproject.mediapackage.Attachment)

process

protected String process(Job job)
                  throws Exception

Asks the overriding class to process the arguments using the given operation. The result will be added to the associated job as the payload.

Specified by:

process in class AbstractJobProducer

Parameters:

job - the job to process

Returns:

the operation result

Throws:

Exception

See Also:

• AbstractJobProducer.process(org.opencastproject.job.api.Job)

analyze

protected VideoText[] analyze(File imageFile,
 String id)
                       throws TextAnalyzerException

Returns the video text element for the given image.

Parameters:

imageFile - the image

id - the video text id

Returns:

the video text found on the image

Throws:

TextAnalyzerException - if accessing the image fails

setServiceRegistry

protected void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the receipt service

Parameters:

serviceRegistry - the service registry

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

See Also:

• AbstractJobProducer.getServiceRegistry()

setTextExtractor

protected void setTextExtractor(TextExtractor textExtractor)

Sets the text extractor.

Parameters:

textExtractor - a text extractor implementation

setWorkspace

protected void setWorkspace(Workspace workspace)

Sets the workspace

Parameters:

workspace - an instance of the workspace

setMpeg7CatalogService

protected void setMpeg7CatalogService(Mpeg7CatalogService mpeg7CatalogService)

Sets the mpeg7CatalogService

Parameters:

mpeg7CatalogService - an instance of the mpeg7 catalog service

setDictionaryService

protected void setDictionaryService(DictionaryService dictionaryService)

Sets the dictionary service

Parameters:

dictionaryService - an instance of the dicitonary service

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Callback for setting the user directory service.

Parameters:

userDirectoryService - the userDirectoryService to set

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)

Sets a reference to the organization directory service.

Parameters:

organizationDirectory - the organization directory

getSecurityService

protected SecurityService getSecurityService()

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

See Also:

• AbstractJobProducer.getSecurityService()

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

See Also:

• AbstractJobProducer.getUserDirectoryService()

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

See Also:

• AbstractJobProducer.getOrganizationDirectoryService()

updated

public void updated(Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

setReadinessIndicator

public void setReadinessIndicator(ReadinessIndicator readinessIndicator)