sbMetadataJobItem Class Reference

#include <sbMetadataJobItem.h>

Inheritance diagram for sbMetadataJobItem:
Collaboration diagram for sbMetadataJobItem:

Public Member Functions

NS_DECL_ISUPPORTS sbMetadataJobItem (sbMetadataJob::JobType aJobType, sbIMediaItem *aMediaItem, nsStringArray *aRequiredProperties, sbMetadataJob *aOwningJob)
virtual ~sbMetadataJobItem ()
nsresult GetHandler (sbIMetadataHandler **aHandler)
nsresult SetHandler (sbIMetadataHandler *aHandler)
nsresult GetMediaItem (sbIMediaItem **aMediaItem)
nsresult GetOwningJob (sbMetadataJob **aJob)
nsresult GetJobType (sbMetadataJob::JobType *aJobType)
nsresult GetProcessingStarted (PRBool *aProcessingStarted)
nsresult SetProcessingStarted (PRBool aProcessingStarted)
nsresult GetProcessed (PRBool *aProcessed)
nsresult SetProcessed (PRBool aProcessed)
nsresult GetURL (nsACString &aURL)
nsresult SetURL (const nsACString &aURL)
nsresult GetProperties (sbIMutablePropertyArray **aPropertyArray)

Protected Attributes

sbMetadataJob::JobType mJobType
nsCOMPtr< sbIMediaItemmMediaItem
nsCOMPtr< sbIMetadataHandlermHandler
nsRefPtr< sbMetadataJobmOwningJob
nsCString mURL
nsStringArray * mPropertyList
PRBool mProcessingStarted
PRBool mProcessingComplete

Detailed Description

Data container representing a single task in an sbFileMetdataService request

Held by an sbMetadataJob in a waiting queue, then taken by a job processor which runs the sbIMetadataHandler and then returns the item to the job.

Instances of this class are not to be shared between threads. Ownership should be transfered between objects at various stages of the job lifecycle.

Definition at line 61 of file sbMetadataJobItem.h.

Constructor & Destructor Documentation

sbMetadataJobItem::sbMetadataJobItem ( sbMetadataJob::JobType  aJobType,
sbIMediaItem aMediaItem,
nsStringArray *  aRequiredProperties,
sbMetadataJob aOwningJob 

Definition at line 56 of file sbMetadataJobItem.cpp.

sbMetadataJobItem::~sbMetadataJobItem ( )

Definition at line 72 of file sbMetadataJobItem.cpp.

Member Function Documentation

nsresult sbMetadataJobItem::GetHandler ( sbIMetadataHandler **  aHandler)

Definition at line 78 of file sbMetadataJobItem.cpp.

Here is the caller graph for this function:

nsresult sbMetadataJobItem::GetJobType ( sbMetadataJob::JobType aJobType)

Definition at line 110 of file sbMetadataJobItem.cpp.

Here is the caller graph for this function:

nsresult sbMetadataJobItem::GetMediaItem ( sbIMediaItem **  aMediaItem)

Definition at line 94 of file sbMetadataJobItem.cpp.

Here is the caller graph for this function:

nsresult sbMetadataJobItem::GetOwningJob ( sbMetadataJob **  aJob)

Definition at line 102 of file sbMetadataJobItem.cpp.

Here is the caller graph for this function:

nsresult sbMetadataJobItem::GetProcessed ( PRBool *  aProcessed)

Definition at line 130 of file sbMetadataJobItem.cpp.

nsresult sbMetadataJobItem::GetProcessingStarted ( PRBool *  aProcessingStarted)

Definition at line 117 of file sbMetadataJobItem.cpp.

nsresult sbMetadataJobItem::GetProperties ( sbIMutablePropertyArray **  aPropertyArray)

Definition at line 154 of file sbMetadataJobItem.cpp.

nsresult sbMetadataJobItem::GetURL ( nsACString &  aURL)

Definition at line 143 of file sbMetadataJobItem.cpp.

Here is the caller graph for this function:

nsresult sbMetadataJobItem::SetHandler ( sbIMetadataHandler aHandler)

Definition at line 88 of file sbMetadataJobItem.cpp.

nsresult sbMetadataJobItem::SetProcessed ( PRBool  aProcessed)

Definition at line 137 of file sbMetadataJobItem.cpp.

nsresult sbMetadataJobItem::SetProcessingStarted ( PRBool  aProcessingStarted)

Definition at line 124 of file sbMetadataJobItem.cpp.

nsresult sbMetadataJobItem::SetURL ( const nsACString &  aURL)

Definition at line 148 of file sbMetadataJobItem.cpp.

Member Data Documentation

nsCOMPtr<sbIMetadataHandler> sbMetadataJobItem::mHandler

Definition at line 89 of file sbMetadataJobItem.h.

sbMetadataJob::JobType sbMetadataJobItem::mJobType

Definition at line 87 of file sbMetadataJobItem.h.

nsCOMPtr<sbIMediaItem> sbMetadataJobItem::mMediaItem

Definition at line 88 of file sbMetadataJobItem.h.

nsRefPtr<sbMetadataJob> sbMetadataJobItem::mOwningJob

Definition at line 90 of file sbMetadataJobItem.h.

PRBool sbMetadataJobItem::mProcessingComplete

Definition at line 99 of file sbMetadataJobItem.h.

PRBool sbMetadataJobItem::mProcessingStarted

Definition at line 96 of file sbMetadataJobItem.h.

nsStringArray* sbMetadataJobItem::mPropertyList

Definition at line 93 of file sbMetadataJobItem.h.

nsCString sbMetadataJobItem::mURL

Definition at line 92 of file sbMetadataJobItem.h.

The documentation for this class was generated from the following files: