FileLinkResourceHandler Class Reference

#include <FileLinkResourceHandler.h>

Inheritance diagram for FileLinkResourceHandler:

Public Types
typedef CPMUnknown < ILinkResourceHandler >	inherited
typedef object_type	data_type

Public Member Functions
	FileLinkResourceHandler (IPMUnknown *boss)
virtual bool	Init (const UIDRef &ref, const URI &uri)
virtual bool	IsResourceURIValid (const UIDRef &ref, const URI &uri) const
virtual bool	AreResourceIdsEquivalent (const ILinkResource::ResourceId &id1, const ILinkResource::ResourceId &id2) const
virtual FileTypeInfo	GetResourceDataType (const UIDRef &ref, const URI &uri) const
virtual WideString	GetShortResourceName (const UIDRef &ref, const URI &uri, bool bUIName) const
virtual WideString	GetLongResourceName (const UIDRef &ref, const URI &uri, bool bUIName) const
virtual PMString	GetResourceStateInfo (const UIDRef &ref, const URI &uri, ILinkResource::ResourceState state, ILinkResource::ResourceStoreState storeState) const
virtual bool	AreStampsEquivalent (const WideString &stamp1, const WideString &stamp2) const
virtual bool	CanReadResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanWriteResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanReadWriteResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanCreateResourceStream (const UIDRef &ref, const URI &uri, ILinkResource::AccessMode mode) const
virtual IPMStream *	CreateResourceReadStream (const UIDRef &ref, const URI &uri) const
virtual IPMStream *	CreateResourceWriteStream (const UIDRef &ref, const URI &uri) const
virtual IPMStream *	CreateResourceReadWriteStream (const UIDRef &ref, const URI &uri) const
virtual bool	CanCacheResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanEmbedResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanUnembedResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanCopyToFile (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	CopyToFile (const UIDRef &ref, const URI &uri, IDFile &file) const
virtual bool	CanEditResource (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	EditResource (const UIDRef &ref, const URI &uri, const AppInfo &appInfo, PMString *errorString) const
virtual bool	CanRevealResource (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	RevealResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanRevealResourceInBridge (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	RevealResourceInBridge (const UIDRef &ref, const URI &uri) const
virtual bool	CanRevealResourceInCloudLibraries (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	RevealResourceInCloudLibraries (const UIDRef &ref, const URI &uri) const
virtual bool	GetXMPPacketInfo (const UIDRef &resourceRef, const URI &uri, std::string &packet) const
virtual bool	CanGetXMPPacketInfo (const UIDRef &ref, const URI &uri) const
virtual bool	CanReplaceFPOWithOriginalResource (const UIDRef &ref, const URI &uri) const
virtual bool	CanDownloadOriginalResource (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	DownloadOriginalResource (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	AsyncDownloadOriginalResource (const UIDRef &ref, const URI &uri, ILinkResource::DownloadCompletionFunction completionFunction) const
virtual ILinkResource::ResourceDownloadState	GetResourceDownloadProgress (const UIDRef &ref, const URI &uri, PMReal &progress) const
virtual bool	CanProvideFile (const UIDRef &ref, const URI &uri) const
virtual ErrorCode	GetFile (const UIDRef &ref, const URI &uri, IDFile &idFile) const
virtual bool	canGetInstanceName () const
virtual ErrorCode	GetInstanceName (PMString &uri) const
Public Member Functions inherited from CPMUnknown< ILinkResourceHandler >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete

Protected Attributes
bool	fbInited
IDFile	fFile
FileTypeInfoID	fFileTypeInfoID
WideString	fShortNameCache
WideString	fShortUINameCache
WideString	fLongNameCache
WideString	fLongUINameCache
Protected Attributes inherited from CPMUnknown< ILinkResourceHandler >
HelperInterface	fHelperInterface

Additional Inherited Members
Protected Member Functions inherited from CPMUnknown< ILinkResourceHandler >
	CPMUnknown (IPMUnknown *boss)

Detailed Description

Implementation of ILinkResourceHandler for a file based link resources. This class serves as the resource handler for all link resources with a URI scheme of 'file', and can be utilized as a base implementation for any link resource that is file based.

See Also

ILinkResourceHandler

Member Function Documentation

virtual bool FileLinkResourceHandler::AreResourceIdsEquivalent ( const ILinkResource::ResourceId &  id1, const ILinkResource::ResourceId &  id2  ) const

virtual

Called to determine if the given resource references are equivalent.

Parameters

id1	[IN] Resource identifier to compare with id2.
id2	[IN] Resource identifier to compare with id1.

Returns

True if the given resource identifiers are equivalent, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::AreStampsEquivalent ( const WideString &  stamp1, const WideString &  stamp2  ) const

virtual

Called to determine if the given resource stamps are equivalent.

Parameters

stamp1	[IN] Stamp to compare with stamp2.
stamp2	[IN] Stamp to compare with stamp1.

Returns

True if the given stamps are equivalent, else false.

Implements ILinkResourceHandler.

virtual ErrorCode FileLinkResourceHandler::AsyncDownloadOriginalResource ( const UIDRef &  ref, const URI &  uri, ILinkResource::DownloadCompletionFunction  completionFunction  ) const

virtual

Called to download original asynchronously for an FPO resource.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to be downloaded.
completionFunction	[IN] completion function to be called at the end of download.

Returns

kSuccess if the resource can be downloaded.

See Also

ILinkResourceRenditionData::ResourceRenditionType

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanCacheResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

Called to determine if a resource can be cached.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be cached, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanCopyToFile ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if a resource can be copied to a file.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be copied to a file, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanCreateResourceStream ( const UIDRef &  ref, const URI &  uri, ILinkResource::AccessMode  access  ) const

virtual

Called to determine if a resource can currently be opened with the given access mode.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.
access	[IN] Type of access desired.

Returns

True if the resource can be opened with the given access mode, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanDownloadOriginalResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if the original for an FPO resource can be downloaded.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the link resource.

Returns

true if the resource can be downloaded, else false.

See Also

ILinkResourceRenditionData::ResourceRenditionType

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanEditResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if a resource can be edited.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be edited, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanEmbedResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

Called to determine if a resource can be embedded.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be embedded, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanGetXMPPacketInfo ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Determines if we can get the XMP Info for the resource.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the link resource.

Returns

true if we can get the XMP info else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanProvideFile ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Determines if a resource can provide the underlying file or not.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the link resource.

Returns

true if the resource can provide the file.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanReadResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if a resource can be read.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be read, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanReadWriteResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if a resource can be read and written simultaneously.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be read and written simultaneously, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanReplaceFPOWithOriginalResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if the FPO resource can be replaced with original.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the link resource.

Returns

true if the FPO resource can be replaced with the original.

See Also

ILinkResourceRenditionData::ResourceRenditionType

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanRevealResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if a resource can be revealed.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be revealed, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanRevealResourceInBridge ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if a resource can be revealed in Adobe Bridge

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be revealed, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanRevealResourceInCloudLibraries ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

Called to determine if a resource can be revealed in CC Libraries panel

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be revealed, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanUnembedResource ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

Called to determine if a resource can be unembedded.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be unembedded, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::CanWriteResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if a resource can be written.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to check.

Returns

True if the resource can be written, else false.

Implements ILinkResourceHandler.

virtual ErrorCode FileLinkResourceHandler::CopyToFile ( const UIDRef &  ref, const URI &  uri, IDFile &  file  ) const

virtual

Called to copy a resource to the given file.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to copy.
file	[IN] File to copy the resource to.

Returns

kSuccess if the resource was successfuly copied, else an error code.

Implements ILinkResourceHandler.

virtual IPMStream* FileLinkResourceHandler::CreateResourceReadStream ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to create a stream that can be used to read data from a resource. \ The caller assumes responsibility for deleting the stream.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to create a read stream for.

Returns

Pointer to a read stream. \ Nil if the resource is not readable.

Implements ILinkResourceHandler.

virtual IPMStream* FileLinkResourceHandler::CreateResourceReadWriteStream ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to create a stream that can be used to read and write data from/to a resource. \ The caller assumes responsibility for deleting the stream.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to create a read/write stream for.

Returns

Pointer to a read/write stream. \ Nil if a read/write stream is not supported.

Implements ILinkResourceHandler.

virtual IPMStream* FileLinkResourceHandler::CreateResourceWriteStream ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to create a stream that can be used to write data to a resource. \ The caller assumes responsibility for deleting the stream.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to create a write stream for.

Returns

Pointer to a write stream. \ Nil if the resource is not writable.

Implements ILinkResourceHandler.

virtual ErrorCode FileLinkResourceHandler::DownloadOriginalResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to download original synchronously for an FPO resource.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to be downloaded.

Returns

kSuccess if the resource was downloaded.

See Also

ILinkResourceRenditionData::ResourceRenditionType

Implements ILinkResourceHandler.

virtual ErrorCode FileLinkResourceHandler::EditResource ( const UIDRef &  ref, const URI &  uri, const AppInfo &  appInfo, PMString *  errorString  ) const

virtual

Called to edit a resource.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to edit.
appInfo	[IN] Indicates which app to edit the resource with. kNullAppInfo means use the default editor.
errorString	[OUT] If editing fails, this fills out an error message when the string pointer is non-nil

Returns

kSuccess if the resource was successfully edited, else an error code.

Implements ILinkResourceHandler.

virtual ErrorCode FileLinkResourceHandler::GetFile ( const UIDRef &  ref, const URI &  uri, IDFile &  idFile  ) const

virtual

Get the underlying file from the link resource.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the link resource.
idFile	[OUT] IDFile of the underlying link resource.

Returns

kSuccess if the underlying file is available, else an error code.

Implements ILinkResourceHandler.

virtual WideString FileLinkResourceHandler::GetLongResourceName ( const UIDRef &  ref, const URI &  uri, bool  bUIName  ) const

virtual

Called to get a resource's long name. \ For example, the long name for a file resource is the file's full path.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to get a long name for.
bUIName	[IN] Denotes to return the resource's long UI name if different from the resource's actual long name.\ In some cases, resources may want to have long UI name that differs from the resource's actual long name. For example, file resources on the Mac return a POSIX path as the resource's actual long name, and a HFS/POSIX path as the resource's long UI name.

Returns

Resource's long name.

Implements ILinkResourceHandler.

virtual FileTypeInfo FileLinkResourceHandler::GetResourceDataType ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to get a resource's data/file type.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to get the data/file type for.

Returns

Resource's data/file type.

Implements ILinkResourceHandler.

virtual ILinkResource::ResourceDownloadState FileLinkResourceHandler::GetResourceDownloadProgress ( const UIDRef &  ref, const URI &  uri, PMReal &  progress  ) const

inlinevirtual

Return resource's download state and fill progress

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the link resource.
progress	[OUT] the download progress, currently unused. resource's download state

Implements ILinkResourceHandler.

virtual PMString FileLinkResourceHandler::GetResourceStateInfo ( const UIDRef &  ref, const URI &  uri, ILinkResource::ResourceState  state, ILinkResource::ResourceStoreState  storeState  ) const

inlinevirtual

Called to get additional information about a resource's state. \ The additional information is added to state string the Links UI displays in the link information pane and the status tooltip.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to get a state informational string for.
state	[IN] Resource's current availability state.
storeState	[IN] Resource's current store state.

Returns

Additional resource state information.

Implements ILinkResourceHandler.

virtual WideString FileLinkResourceHandler::GetShortResourceName ( const UIDRef &  ref, const URI &  uri, bool  bUIName  ) const

virtual

Called to get a resource's short name. \ For example, the short name for a file resource is the file's name.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to get a short name for.
bUIName	[IN] Denotes to return the resource's short UI name if different from the resource's actual short name.\ In some cases, resources may want to have short UI name that differs from the resource's actual short name. For example, file resources on the Mac return a POSIX file name as the resource's actual short name, and a HFS/POSIX file name as the resource's short UI name.

Returns

Resource's short name.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::GetXMPPacketInfo ( const UIDRef &  resourceRef, const URI &  uri, std::string &  packet  ) const

virtual

Get the XMP Info for the resource

Parameters

resourceRef	[IN] UID reference of the link resource.
uri	[IN] URI of the link resource.
packet	[OUT] the resource's XMP info

Returns

true if the XMP info is filled in packet else false .

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::Init ( const UIDRef &  ref, const URI &  uri  )

virtual

Called by the LinkResource to allow the handler to initialize itself. This method can be used by the handler to optimize its resource handling. For example, the handler may want to parse the URI in this method so that calls to other methods can used the parsed information.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the link resource.

Returns

True if the handler initializes without errors, else false.

Implements ILinkResourceHandler.

virtual bool FileLinkResourceHandler::IsResourceURIValid ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to determine if the provider supports the given URI.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI to check.

Returns

True if the URI is supported, else false.

Implements ILinkResourceHandler.

virtual ErrorCode FileLinkResourceHandler::RevealResource ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to reveal a resource.

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to reveal.

Returns

kSuccess if the resource was successfully revealed, else an error code.

Implements ILinkResourceHandler.

virtual ErrorCode FileLinkResourceHandler::RevealResourceInBridge ( const UIDRef &  ref, const URI &  uri  ) const

virtual

Called to reveal a resource in Adobe Bridge

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to reveal.

Returns

kSuccess if the resource was successfully revealed, else an error code.

Implements ILinkResourceHandler.

virtual ErrorCode FileLinkResourceHandler::RevealResourceInCloudLibraries ( const UIDRef &  ref, const URI &  uri  ) const

inlinevirtual

Called to reveal a resource in CC Libraries panel

Parameters

ref	[IN] UID reference of the link resource.
uri	[IN] URI of the resource to reveal.

Returns

kSuccess if the resource was successfully revealed, else an error code.

Implements ILinkResourceHandler.

Member Data Documentation

bool FileLinkResourceHandler::fbInited

protected

Denotes whether the handler was able to successfully initialize via a call to Init() by converting the link resource's URI to an IDFile.

IDFile FileLinkResourceHandler::fFile

protected

The file referenced in the link resource's URI.

FileTypeInfoID FileLinkResourceHandler::fFileTypeInfoID

mutableprotected

Key used to access the file's type, creator, file extension, and mime type from the FileTypeRegistry.

WideString FileLinkResourceHandler::fShortNameCache

mutableprotected

Caches used to store the resource's short and long names so that they don't have to regenerated every time. The caches should always be invalidated every time the handler is initialized.