maxon.FileFormatHandlerInterface

Description

FileFormatHandlerInterface implements a handler for a specific FileFormat.

Note

Two different implementations could offer different loaders for one and the same FileFormat.

maxon.FileFormat.Zip implements one handler for Directory Browsing (maxon.IoBrowseRef) and one for maxon.ReadArchiveRef.

Inheritance diagram

Inheritance

Parent Class:

• maxon.ObjectInterface

Child Class:

• maxon.FileFormatHandler

Methods Signature

CreateHandler(HANDLER, url)	Creates an maxon.ObjectRef which handles the given url with the specific interface.
GetDependends(url)	Returns the dependencies of this maxon.FileFormatHandler.
GetFileFormat()	Returns the maxon.FileFormat which is handled by this maxon.FileFormatHandler.
GetHandlerType()	Returns the maxon.DataType of the reference class of the handler returned by FileFormatHandlerInterface.CreateHandler().

Methods Definition

FileFormatHandlerInterface.CreateHandler(HANDLER, url)

Creates an maxon.ObjectRef which handles the given url with the specific interface.

Note

maxon.FileFormat.Zip implements one handler for Directory Browsing “maxon.IoBrowseRef” and one for workign with archives “maxon.ReadArchiveRef”.

Parameters

• HANDLER (Union[maxon.UrlInterface, maxon.Data, type]) – Reference class to be expected with the result of CreateHandler.

• url (maxon.Url) – maxon.Url to be used with this handler.

Returns

Reference class to be expected with the result of CreateHandler.

Return type

same as HANDLER

FileFormatHandlerInterface.GetDependends(url)

Returns the dependencies of this maxon.FileFormatHandler.

This allows to give an priority order for a implementation.

Warning

This function should not be called except from FileFormatDetectionInterface.DetectAll().

Returns

Defines the priority order of file formats. The lower the value the later it will be called.

Return type

maxon.FILEFORMAT_PRIORITY

FileFormatHandlerInterface.GetFileFormat()

Returns the maxon.FileFormat which is handled by this maxon.FileFormatHandler.

Returns

The file format.

Return type

maxon.FileFormat

FileFormatHandlerInterface.GetHandlerType()

Returns the maxon.DataType of the reference class of the handler returned by FileFormatHandlerInterface.CreateHandler().

Returns

The data type of the reference class.

Return type

maxon.DataType