Apache OpenOffice Wiki - User contributions [en]

Uno/Cpp/Tutorials/component tutorial

2014-01-17T08:32:32Z

Zhaoshzh:

= Introduction =

This tutorial is a general example of how to write a UNO component and how to use it in applications, for example StarOffice or OpenOffice.org. This example is written in C++, however differences for implementing the component in Java will be mentioned.

The component is a basic counter, whose value can be set, read, incremented and decremented.

= Interfaces =

The first step, in writing any component (in almost any language environment) is to specify one or more interfaces that the component must implement.

Interfaces are the key to hiding implementation details in any modern development environment. They are contracts between a client that wants to use a components' functionality and the component (serving this functionality). In UNO terminology, UNO components are called services.

Interfaces separate the specific implementation (there can more than one for a service) from the usage. The client using the component does not have any insight how the component is implemented.

Interfaces are specified using an Interface definition language (IDL). UNO uses UNO-IDL as the interface definition language. An interface for a Counter might look like this:

file counter.idl:
<source lang="idl">
#include <com/sun/star/uno/XInterface.idl>
module foo
{
/**
* Interface to count things.
*/
[ uik(3806AFF0-75A0-11d3-87B300A0-24494732), ident("XCountable", 1.0) ]
interface XCountable : com::sun::star::uno::XInterface
{
long getCount();
void setCount( [in] long nCount );
long increment();
long decrement();
};
};
</source>

Any interface that is specified is derived from XInterface, the basic interface in UNO. The XInterface has methods for lifetime control of the interface (acquire() and release()) and the ability to query for further interfaces of the UNO object (queryInterface()). Once you have an interface of an object, you can query for any others the object provides. If there are no acquired interfaces (references) left on an UNO object, the object might disappear. Interfaces (and services) can be grouped in modules to avoid pollution of the global namespace.

= Services =

Any UNO component (service) exports one or more interfaces that the clients are using. All services are specified using the service directive in an IDL file:

<source lang="idl">
module foo

{
service Counter
{
// exported interfaces:
interface XCountable;
};
};
</source>
The service declaration introduces a service called foo.Counter which supports the XCountable interface.

There are some more IDL features, e.g. attributes, structs, enums, that are omitted at this time. All IDL declarations are put into a typelibrary file (rdb file). This speeds up the back end generation of the language specific files.

To implement the interfaces, the appropriate interface code for the implementation language has to be generated from the rdb file.

In C++ a tool called cppumaker generates pure abstract classes that the component has to implement. This is a common way to describe interfaces in C++. The Java language directly supports interfaces as a language feature (javamaker will generate Java interfaces).

= Implementation =

A component that is implemented in C++ is normally packaged in a shared library. This shared lib exports two symbols, which are explained further below. Java implementations are normally packaged in a JAR file. In this case the manifest file identifies a class implementing two methods with similar semantics.

A simple implementation of the counting UNO service foo.Counter might be:
<source lang="cpp">
//file foo.cxx:

#include <rtl/ustring.hxx>
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/factory.hxx>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/registry/XRegistryKey.hpp>
#include <foo/XCountable.hpp>

using namespace rtl;
using namespace com::sun::star::uno;
using namespace com::sun::star::lang;
using namespace com::sun::star::registry;
using namespace foo;

//==================================================================================================
class MyCounterImpl : public cppu::WeakImplHelper1< XCountable >
{
// to obtain other services if needed
Reference< XMultiServiceFactory > _xServiceManager;

sal_Int32 _nCount;

Reference< XText > _xText;
void dump( sal_Int32 nValue ) const;

public:
MyCounterImpl( const Reference< XMultiServiceFactory > & xServiceManager );
virtual ~MyCounterImpl();

// XCountable implementation
virtual sal_Int32 SAL_CALL getCount() throw (RuntimeException);
virtual void SAL_CALL setCount( sal_Int32 nCount ) throw (RuntimeException);
virtual sal_Int32 SAL_CALL increment() throw (RuntimeException);
virtual sal_Int32 SAL_CALL decrement() throw (RuntimeException);
};
//__________________________________________________________________________________________________
MyCounterImpl::MyCounterImpl( const Reference< XMultiServiceFactory > & xServiceManager )
: _xServiceManager( xServiceManager )
{
cerr << "< MyCounterImpl ctor called >" << endl;

if (_xServiceManager.is())
{
Reference< XComponentLoader > xLoader( _xServiceManager->createInstance(
L"com.sun.star.frame.Desktop" ), UNO_QUERY );
if (xLoader.is())
{
Reference< XTextDocument > xDoc( xLoader->loadComponentFromURL(
L"private:scalc/factory", L"_blank", 0, Sequence< PropertyValue >() ), UNO_QUERY );
if (xDoc.is())
_xText = xTextDoc->getText();
}
}
}
//__________________________________________________________________________________________________
MyCounterImpl::~MyCounterImpl()
{
cerr << "< MyCounterImpl dtor called >" << endl;
}
//__________________________________________________________________________________________________
void MyCounterImpl::dump( sal_Int32 nValue ) const
{
if (_xText.is())
_xText->setValue( nValue );
else
cerr << endl << nValue;
}

// XCountable implementation
//__________________________________________________________________________________________________
sal_Int32 MyCounterImpl::getCount() throw (RuntimeException)
{
return _nCount;
}
//__________________________________________________________________________________________________
void MyCounterImpl::setCount( sal_Int32 nCount ) throw (RuntimeException)
{
_nCount = nCount;
dump( _nCount );
}
//__________________________________________________________________________________________________
sal_Int32 MyCounterImpl::increment() throw (RuntimeException)
{
++_nCount;
dump( _nCount );
return _nCount;
}
//__________________________________________________________________________________________________
sal_Int32 MyCounterImpl::decrement() throw (RuntimeException)
{
--_nCount;
dump( _nCount );
return _nCount;
}

/**
* Function to create a new component instance; is needed by factory helper implementation.
* @param xMgr service manager to if the components needs other component instances
*/
Reference< XInterface > MyCounterImpl_create(
const Reference< XMultiServiceFactory > & xMgr )
{
return Reference< XInterface >( new MyCounterImpl( xMgr ) );
}

</source>

{{Documentation/Caution|The instanciation of a component has changed since this article has been written. The constructor has to use a context instead of a service manager [[Documentation/DevGuide/ProUNO/Service_Manager_and_Component_Context|(see Developer's Guide)]].}}

The generated header file declares an abstract C++ class and a function called getCppuType(). Any generated type has its getCppuType() describing the type, for example.

<source lang="cpp">
const com::sun::star::uno::Type & SAL_CALL getCppuType( const com::sun::star::uno::Reference< foo::XCountable > * );
</source>

describes the XCountable interface. Only the type of the parameter is of importance. By using overloaded getCppuType() functions for any type, it is possible to get runtime type information. It is also possible to use little helpers like a template queryInterface() function used for the implementation of XInterface::queryInterface().

So how is the UNO component instantiated? As mentioned above, four symbols are exported by the shared library, providing four functions: component_getDescriptionFunc(), component_getImplementationEnvironment(), component_writeInfo() and component_getFactory().

The first is called to get a description of the component. This function returns a XML formatted string which describes the component. This function could be generated from the XML description with the xml2cmp tool. Each component should provide such a XML description. The second is called from a loader service to get information about the used environment of the component. The third is called whenever the component is registered in some registry file and the latter is called to obtain a factory to get instances of the component.

They are typically implemented as follows:

<source lang="cpp">
/**
* This function returns the name of the used environment.
* @param ppEnvTypeName name of the environment
* @param ppEnv could be point to a special environment, this parameter is normally set to null
*/
extern "C" void SAL_CALL component_getImplementationEnvironment(
const sal_Char ** ppEnvTypeName, uno_Environment ** ppEnv )
{
*ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
}

/**
* This function creates an implementation section in the registry and another subkey
* for each supported service.
* @param pServiceManager generic uno interface providing a service manager
* @param pRegistryKey generic uno interface providing registry key to write
*/
extern "C" sal_Bool SAL_CALL component_writeInfo( void* pServiceManager, void* pRegistryKey )
{
if (pRegistryKey)
{
try
{
Reference< XRegistryKey > xNewKey(
reinterpret_cast< XRegistryKey * >( pRegistryKey )->createKey(
OUString( RTL_CONSTASCII_USTRINGPARAM("/foo.MyCounterImpl/UNO/SERVICES") ) ) );
xNewKey->createKey( OUString( RTL_CONSTASCII_USTRINGPARAM("foo.Counter") ) );
return sal_True;
}
}
return sal_False;
}
</source>
component_writeInfo() will write information about all service implementations that are in the shared library. Each service implementation is registered under its implementation name in the implementation section, followed by its service name. The hierarchical structure of the registry is as follows:

<pre>
/IMPLEMENTATIONS/
/foo.MyCounterImpl // implementation name
/UNO
/SERVICES
/foo.Counter // service name
/bar.AnotherCounterImpl // implementation name
/UNO
/SERVICES
/foo.Counter // service name
...
</pre>
<source lang="cpp">
/**
* Function to create a new component instance; is needed by factory helper implementation.
* @param xMgr service manager to if the components needs other component instances
*/
Reference< XInterface > MyCounterImpl_create( const Reference< XMultiServiceFactory > & xMgr )
{
return Reference< XInterface >( new MyCounterImpl( xMgr ) );
}

/**
* This function is called to get service factories for an implementation.
* @param pImplName name of implementation
* @param pServiceManager generic uno interface providing a service manager to instantiate components
* @param pRegistryKey registry data key to read and write component persistent data
* @return a component factory (generic uno interface)
*/
extern "C" void * SAL_CALL component_getFactory(
const sal_Char * pImplName, void * pServiceManager, void * pRegistryKey )
{
void * pRet = 0;
// which implementation is required?
if (pServiceManager && rtl_str_compare( pImplName, "foo.MyCounterImpl" ))
{
rtl::OUString aServiceName( RTL_CONSTASCII_USTRINGPARAM("foo.Counter") );
Reference< XSingleServiceFactory > xFactory(
cppu::createSingleFactory( // helper function from cppuhelper lib
reinterpret_cast< XMultiServiceFactory * >( pServiceManager ),
OUString( RTL_CONSTASCII_USTRINGPARAM("foo.MyCounterImpl") ),
MyCounterImpl_create,
Sequence< rtl::OUString >( &aServiceName, 1 ) ) );
if (xFactory.is())
{
xFactory.acquire();
pRet = xFactory.get();
}
}
return pRet;
}
</source>
component_getFactory() demands a certain implementation from the shared library. The returned uno interface is a component factory that is used to produce service instances of the component implementation. The first parameter identifies the name of the required implementation. This name must correspond to the registered one from component_writeInfo(). The second parameter provides a service manager instance, components can use this for getting further components. The last parameter provides a registry key to the implementation section of the component, so it can read and write persistent data to the registry, e.g. for booting.

When working in the OpenOffice build framework, make sure to add these functions to the util/NAME.map file, eg
when adding the first UNO service to calc's scfilt library, do
<source lang=bash>
--- sc/util/scfilt.map
+++ sc/util/scfilt.map
@@ -1,6 +1,9 @@
SCFILT_1_0 {
global:
ScFilterCreate;
+ component_getImplementationEnvironment;
+ component_writeInfo;
+ component_getFactory;
local:
*;
};
</source>

and that you tell scp2 the library is a UNO library, in the case of scfilt, do
<source lang=bash>
--- scp2/source/calc/file_calc.scp
+++ scp2/source/calc/file_calc.scp
@@ -49,7 +49,7 @@ STD_UNO_LIB_FILE_PATCH( gid_File_Lib_Sc, sc)

STD_LIB_FILE_PATCH( gid_File_Lib_Scui, scui)

-STD_LIB_FILE( gid_File_Lib_Scfilt, scfilt)
+STD_UNO_LIB_FILE( gid_File_Lib_Scfilt, scfilt)

STD_UNO_LIB_FILE( gid_File_Lib_Scd, scd)
</source>
=Attentions after Passive Component Registration=
1. create a new .component file,for example,
create scfilt.component in sc/util,

<source lang=bash>
<component loader="com.sun.star.loader.SharedLibrary"

xmlns="http://openoffice.org/2010/uno-components">

<implementation name="com.sun.star.comp.ExcelFilterExport">

<service name="com.sun.star.document.ExportFilter"/>

</implementation>

</component>

</source>
2. add the new component in the make file,for example,
add scfilt.component,the code should like this:
<source lang=bash>
ALLTAR : $(MISC)/sc.component $(MISC)/scfilt.component $(MISC)/scd.component $(MISC)/vbaobj.component

$(MISC)/sc.component .ERRREMOVE : $(SOLARENV)/bin/createcomponent.xslt \
sc.component
$(XSLTPROC) --nonet --stringparam uri \
'$(COMPONENTPREFIX_BASIS_NATIVE)$(SHL1TARGETN:f)' -o $@ \
$(SOLARENV)/bin/createcomponent.xslt sc.component

$(MISC)/scfilt.component .ERRREMOVE : $(SOLARENV)/bin/createcomponent.xslt \
scfilt.component
$(XSLTPROC) --nonet --stringparam uri \
'$(COMPONENTPREFIX_BASIS_NATIVE)$(SHL6TARGETN:f)' -o $@ \
$(SOLARENV)/bin/createcomponent.xslt scfilt.component
</source>

3. deliver the .component file.for example,
in sc/prj/d.lst
<source lang=bash>
..\%__SRC%\misc\scfilt.component %_DEST%\xml%_EXT%\scfilt.component
</source>
4. if your service implement is a DLL,then add the module component to the list in

postprocess/packcomponets/makefile.mk,for example,
add 'scfilt'to the list of my_components.

Author: Daniel Bölzle ($Date: 2004/11/17 12:41:00 $)
Copyright 2001 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.

=See also=
* [[Constructing_Components|Constructing Components]]
* [[Component_and_Dialog|The Counter Component with a dialog]]
* [[Uno/Cpp/Tutorials/Introduction_to_Cpp_Uno|C++ and UNO tutorial]]
* [[UNO_component_packaging|Component with Python]]

[[Category:Uno]]
[[Category:Uno:Cpp]]
[[Category:Tutorial]]
[[Category:Cpp]]
[[Category:Extensions]]
[[Category:Add-In]]
[[Category:Add-On]]

Talk:JavaEclipseTuto

2014-01-10T23:16:18Z

Zhaoshzh:

Is there some reason that this is called JavaEclipseTuto instead of JavaEclipesTutorial??
--[[User:Mikeleib|Mikeleib]] 21:52, 17 March 2006 (CET)
To make it shorter, but if you mind it would be better... I don't see any problem

--[[User:Cedricbosdo|cedricbosdo]] 09:51, 19 March 2006 (CET)

Hi,

I'm trying to get a Java component working in OpenOffice, but for some reason I'm not very lucky at it.
So I took some step's back and tried your HelloWorld example by the letter.

I still have no successfull creation of a Java component, but I do have some observations and questions.

When I follow the example, an implementation class file pops up in gedit (source/org/openoffice/helloworld/HelloworldImpl)
The generated MANIFEST.MF searches that file like:
ManifestVersion: 1.0
RegistrationClassName: org.openoffice.helloworld.comp.HelloworldImpl
There is also a class org.openoffice.helloworld.Helloworld. (I assume this is generated by a tool like JavaMaker?).
This is also the class which is refered to in 'types.rdb' and 'Helloworld.rdb'
I have the impression, this should be 'HelloworldImpl'. (EDIT: Obviously not)

When I try to export the project, there is an error message about 'services.rdb':

[[Image:Package-export-error.png]]

So my questions are:
* Should I implement HelloworldImpl or Helloworld (EDIT: the Impl)
* If not the latter, what's the purpose of Helloworld. (SOme kind of placeholder?)
* What must be done to get rid of the services.rdb missing message
* can I view error messages or obtain a list of executed commands somewhere (ah, I will do as said in the troubleshooting page. (Not very informative though))

I'm using SDK 2.2 (680m6)(and also 680m14 from Ubuntu:feisty) and OpenOffice 2.2.0-1ubuntu3

* EDIT 1: using the distribution SDK seems to help a lot indeed. I can generate a HelloworldImpl now.
* EDIT 2: well, it seems to work. I created my own project, and the export worked. However, I had to change something
(removed and reimported it to eclipse) and the export does not seem to work anymore (An internal error occured during "Package export job"). What are the pre-requisites? How can I find out what's going wrong. (I could find no relevant message in workspace/.metadata/.log)
* EDIT 3: Appart from 'export', I got my project functioning also (10 July).

Regards,
--[[User:Steckelfisch|Steckelfisch]] 9-11 July 2007

-------------------------------------------------------
when you build ooeclipseintegration
you should add parameter of -Dopenoffice.home and -Declipse.home

Calc/Performance/CellStyles OoxML

2012-10-19T03:07:03Z

Zhaoshzh: moved Calc/Performance/CellStyles OoxML to Calc/Performance/CellStylesOfOoxML over redirect

#REDIRECT [[Calc/Performance/CellStylesOfOoxML]]

Calc/Performance/CellStylesOfOoxML

2012-10-19T03:07:03Z

Zhaoshzh: moved Calc/Performance/CellStyles OoxML to Calc/Performance/CellStylesOfOoxML over redirect

<noinclude>{{DISPLAYTITLE:Calc Performance Optimizations for CellStylesInOoxML}}</noinclude>

[[Category:Calc|Performance/CellStylesInOoxML]]
[[Category:Performance]]
[[Category:Done]]

If there are a lot of cell styles in MS 2007 .xlsx file, when loading the file in Aoo,
it will take about 20 seconds to create the cell styles.

After analyze the sample file, there are lots of duplicated cell style items in the
original file,and such file maybe created by script or other tools. So a method must
be used to get rid of the duplicated unused cell styles.

In MS 2007 .xlsx file,there are 3 items to record the cell style.
*cellStyleXfs

This element contains the master formatting records (xf's) which define the formatting for all named cell styles
in this workbook. Master formatting records reference individual elements of formatting (e.g., number format,
font definitions, cell fills, etc) by specifying a zero-based index into those collections. Master formatting records
also specify whether to apply or ignore particular aspects of formatting, for example whether to apply a border
or not.
*cellXfs

This element contains the master formatting records (xf) which define the formatting applied to cells in this
workbook. These records are the starting point for determining the formatting for a cell. Cells in the Sheet Part
reference the xf records by zero-based index.

*cellStyles
This element contains the named cell styles, consisting of a sequence of named style records. A named cell style
is a collection of direct or themed formatting (e.g., cell border, cell fill, and font type/size/style) grouped
together into a single named style, and can be applied to a cell.

Here is the relationship.

[[File:Cellstyle_relationship.JPG]]

Here is the result data by the rational purify.

Calls: 178,325
F+D: 25,128,429

Calls: 4,268
F+D: 24,404,739

1) ScCellRangesBase::setPropertyValues Calls: 45,336
F+D: 13,999,231

2) ScCellRangesBase::setPropertyValue Calls: 36,334
F+D: 8,745,959

3) ScStyleObj::setPropertyValues Calls: 28,282
F+D: 10,547,312

1)oox::xls::OoxSheetDataContext::onCreatContext 1) oox::xls::OoxSheetDataContext::importRow

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet

4) ScStyleObj::setPropertyValue Calls: 36,334

F+D: 8,745,959

Calls:178,308

F+D: 5,538,047

Calls: 158,771

F+D: 4,810,522

1) ScCellRangesBase::setPropertyValues

2) ScCellRangesBase::setPropertyValue

3) ScStyleObj::setPropertyValues

2)oox::xls::OoxSheetDataContext::onEndElement 1) oox::xls::WorksheetHelper::setCellFormat

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet
oox::xls::StylesBuffer::writeFillToPropertySet 4) ScStyleObj::setPropertyValue
Calls: 1
F+D: 21,475,924

Calls: 14,234

F+D: 21,419,377

1) ScCellRangesBase::setPropertyValues
2) ScCellRangesBase::setPropertyValue
3) ScStyleObj::setPropertyValues

3)oox::xls::OoxStylesFragement::finalizeImport 1) oox::xls::CellStyle::createStyle

oox::xls::StylesBuffer::writeStylesXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet
4) ScStyleObj::setPropertyValue

The oox::xls::CellStyle::createStyle is called 14,234 times, and the F+D: 21,419,377

----
In this solution:

1. if there are two same cell styles,named "style1" and "style2",
if a cell uses the second one,all the two cell styles will be created.
*the used styles should be imported.
*the unused duplicate styles should be imported only once.
2. if there are two different cell styles, all the styles will be imported to spreadsheet.

3. if there are two same cell styles, but they are used by different cells,
all of them will be imported to spreadsheet.

4. if there are two same cell styles, and they are not used by any cell,
only import the first one to spreadsheet.

Calc/Performance/CellStylesOfOoxML

2012-10-19T03:06:16Z

Zhaoshzh: moved Calc/Performance/CellStylesOfOoxML to Calc/Performance/CellStyles OoxML

Calc/Performance/CellStylesOfOoxML

2012-10-19T03:04:10Z

Zhaoshzh:

Calc/Performance/CellStylesOfOoxML

2012-09-21T05:32:29Z

Zhaoshzh:

<noinclude>{{DISPLAYTITLE:Calc Performance Optimizations for CellStylesInOoxML}}</noinclude>

[[Category:Calc|Performance/CellStylesInOoxML]]
[[Category:Performance]]
[[Category:Done]]

If there are a lot of cell styles in MS 2007 .xlsx file, when loading the file in Aoo,
it will take about 20 seconds to create the cell styles.

After analyze the sample file, there are lots of duplicated cell style items in the
original file,and such file maybe created by script or other tools. So a method must
be used to get rid of the duplicated unused cell styles.

In MS 2007 .xlsx file,there are 3 items to record the cell style.
*cellStyleXfs

This element contains the master formatting records (xf's) which define the formatting for all named cell styles
in this workbook. Master formatting records reference individual elements of formatting (e.g., number format,
font definitions, cell fills, etc) by specifying a zero-based index into those collections. Master formatting records
also specify whether to apply or ignore particular aspects of formatting, for example whether to apply a border
or not.
*cellXfs

This element contains the master formatting records (xf) which define the formatting applied to cells in this
workbook. These records are the starting point for determining the formatting for a cell. Cells in the Sheet Part
reference the xf records by zero-based index.

*cellStyles
This element contains the named cell styles, consisting of a sequence of named style records. A named cell style
is a collection of direct or themed formatting (e.g., cell border, cell fill, and font type/size/style) grouped
together into a single named style, and can be applied to a cell.

Here is the relationship.

[[File:Cellstyle_relationship.JPG]]

Here is the result data by the rational purify.

Calls: 178,325
F+D: 25,128,429

Calls: 4,268
F+D: 24,404,739

1) ScCellRangesBase::setPropertyValues Calls: 45,336
F+D: 13,999,231

2) ScCellRangesBase::setPropertyValue Calls: 36,334
F+D: 8,745,959

3) ScStyleObj::setPropertyValues Calls: 28,282
F+D: 10,547,312

1)oox::xls::OoxSheetDataContext::onCreatContext 1) oox::xls::OoxSheetDataContext::importRow

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet

4) ScStyleObj::setPropertyValue Calls: 36,334

F+D: 8,745,959

Calls:178,308

F+D: 5,538,047

Calls: 158,771

F+D: 4,810,522

1) ScCellRangesBase::setPropertyValues

2) ScCellRangesBase::setPropertyValue

3) ScStyleObj::setPropertyValues

2)oox::xls::OoxSheetDataContext::onEndElement 1) oox::xls::WorksheetHelper::setCellFormat

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet
oox::xls::StylesBuffer::writeFillToPropertySet 4) ScStyleObj::setPropertyValue
Calls: 1
F+D: 21,475,924

Calls: 14,234

F+D: 21,419,377

1) ScCellRangesBase::setPropertyValues
2) ScCellRangesBase::setPropertyValue
3) ScStyleObj::setPropertyValues

3)oox::xls::OoxStylesFragement::finalizeImport 1) oox::xls::CellStyle::createStyle

oox::xls::StylesBuffer::writeStylesXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet
4) ScStyleObj::setPropertyValue

The oox::xls::CellStyle::createStyle is called 14,234 times, and the F+D: 21,419,377

----
In this solution:

1. if there are two same cell styles,named "style1" and "style2",
if a cell uses the second one,all the two cell styles will be created.

2. if there are two different cell styles, all the styles will be imported to spreadsheet.

3. if there are two same cell styles, but they are used by different cells,
all of them will be imported to spreadsheet.

4. if there are two same cell styles, and they are not used by any cell,
only import the first one to spreadsheet.

Calc/Performance/CellStylesOfOoxML

2012-09-21T05:29:51Z

Zhaoshzh:

<noinclude>{{DISPLAYTITLE:Calc Performance Optimizations for CellStylesInOoxML}}</noinclude>

[[Category:Calc|! Performance]]
[[Category:Performance]]

If there are a lot of cell styles in MS 2007 .xlsx file, when loading the file in Aoo,
it will take about 20 seconds to create the cell styles.

After analyze the sample file, there are lots of duplicated cell style items in the
original file,and such file maybe created by script or other tools. So a method must
be used to get rid of the duplicated unused cell styles.

In MS 2007 .xlsx file,there are 3 items to record the cell style.
*cellStyleXfs

This element contains the master formatting records (xf's) which define the formatting for all named cell styles
in this workbook. Master formatting records reference individual elements of formatting (e.g., number format,
font definitions, cell fills, etc) by specifying a zero-based index into those collections. Master formatting records
also specify whether to apply or ignore particular aspects of formatting, for example whether to apply a border
or not.
*cellXfs

This element contains the master formatting records (xf) which define the formatting applied to cells in this
workbook. These records are the starting point for determining the formatting for a cell. Cells in the Sheet Part
reference the xf records by zero-based index.

*cellStyles
This element contains the named cell styles, consisting of a sequence of named style records. A named cell style
is a collection of direct or themed formatting (e.g., cell border, cell fill, and font type/size/style) grouped
together into a single named style, and can be applied to a cell.

Here is the relationship.

[[File:Cellstyle_relationship.JPG]]

Here is the result data by the rational purify.

Calls: 178,325
F+D: 25,128,429

Calls: 4,268
F+D: 24,404,739

1) ScCellRangesBase::setPropertyValues Calls: 45,336
F+D: 13,999,231

2) ScCellRangesBase::setPropertyValue Calls: 36,334
F+D: 8,745,959

3) ScStyleObj::setPropertyValues Calls: 28,282
F+D: 10,547,312

1)oox::xls::OoxSheetDataContext::onCreatContext 1) oox::xls::OoxSheetDataContext::importRow

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet

4) ScStyleObj::setPropertyValue Calls: 36,334

F+D: 8,745,959

Calls:178,308

F+D: 5,538,047

Calls: 158,771

F+D: 4,810,522

1) ScCellRangesBase::setPropertyValues

2) ScCellRangesBase::setPropertyValue

3) ScStyleObj::setPropertyValues

2)oox::xls::OoxSheetDataContext::onEndElement 1) oox::xls::WorksheetHelper::setCellFormat

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet
oox::xls::StylesBuffer::writeFillToPropertySet 4) ScStyleObj::setPropertyValue
Calls: 1
F+D: 21,475,924

Calls: 14,234

F+D: 21,419,377

1) ScCellRangesBase::setPropertyValues
2) ScCellRangesBase::setPropertyValue
3) ScStyleObj::setPropertyValues

3)oox::xls::OoxStylesFragement::finalizeImport 1) oox::xls::CellStyle::createStyle

oox::xls::StylesBuffer::writeStylesXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet
4) ScStyleObj::setPropertyValue

The oox::xls::CellStyle::createStyle is called 14,234 times, and the F+D: 21,419,377

----
In this solution:

1. if there are two same cell styles,named "style1" and "style2",
if a cell uses the second one,all the two cell styles will be created.

2. if there are two different cell styles, all the styles will be imported to spreadsheet.

3. if there are two same cell styles, but they are used by different cells,
all of them will be imported to spreadsheet.

4. if there are two same cell styles, and they are not used by any cell,
only import the first one to spreadsheet.

Calc/Performance/CellStylesInOoxML

2012-09-21T03:36:06Z

Zhaoshzh: moved Calc/Performance/CellStylesInOoxML to Calc/Performance/CellStylesOfOoxML

#REDIRECT [[Calc/Performance/CellStylesOfOoxML]]

Calc/Performance/CellStylesOfOoxML

2012-09-21T03:36:06Z

Zhaoshzh: moved Calc/Performance/CellStylesInOoxML to Calc/Performance/CellStylesOfOoxML

<noinclude>{{DISPLAYTITLE:Calc Performance Optimizations for CellStylesInOoxML}}</noinclude>

[[Category:Calc|Performance/{{SUBPAGENAME}}]]
[[Category:Done]]
[[Category:Performance]]

If there are a lot of cell styles in MS 2007 .xlsx file, when loading the file in Aoo,
it will take about 20 seconds to create the cell styles.

After analyze the sample file, there are lots of duplicated cell style items in the
original file,and such file maybe created by script or other tools. So a method must
be used to get rid of the duplicated unused cell styles.

In MS 2007 .xlsx file,there are 3 items to record the cell style.
*cellStyleXfs

This element contains the master formatting records (xf's) which define the formatting for all named cell styles
in this workbook. Master formatting records reference individual elements of formatting (e.g., number format,
font definitions, cell fills, etc) by specifying a zero-based index into those collections. Master formatting records
also specify whether to apply or ignore particular aspects of formatting, for example whether to apply a border
or not.
*cellXfs

This element contains the master formatting records (xf) which define the formatting applied to cells in this
workbook. These records are the starting point for determining the formatting for a cell. Cells in the Sheet Part
reference the xf records by zero-based index.

*cellStyles
This element contains the named cell styles, consisting of a sequence of named style records. A named cell style
is a collection of direct or themed formatting (e.g., cell border, cell fill, and font type/size/style) grouped
together into a single named style, and can be applied to a cell.

Here is the relationship.

[[File:Cellstyle_relationship.JPG]]

Here is the result data by the rational purify.

Calls: 178,325
F+D: 25,128,429

Calls: 4,268
F+D: 24,404,739

1) ScCellRangesBase::setPropertyValues Calls: 45,336
F+D: 13,999,231

2) ScCellRangesBase::setPropertyValue Calls: 36,334
F+D: 8,745,959

3) ScStyleObj::setPropertyValues Calls: 28,282
F+D: 10,547,312

1)oox::xls::OoxSheetDataContext::onCreatContext 1) oox::xls::OoxSheetDataContext::importRow

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet

4) ScStyleObj::setPropertyValue Calls: 36,334

F+D: 8,745,959

Calls:178,308

F+D: 5,538,047

Calls: 158,771

F+D: 4,810,522

1) ScCellRangesBase::setPropertyValues

2) ScCellRangesBase::setPropertyValue

3) ScStyleObj::setPropertyValues

2)oox::xls::OoxSheetDataContext::onEndElement 1) oox::xls::WorksheetHelper::setCellFormat

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet
oox::xls::StylesBuffer::writeFillToPropertySet 4) ScStyleObj::setPropertyValue
Calls: 1
F+D: 21,475,924

Calls: 14,234

F+D: 21,419,377

1) ScCellRangesBase::setPropertyValues
2) ScCellRangesBase::setPropertyValue
3) ScStyleObj::setPropertyValues

3)oox::xls::OoxStylesFragement::finalizeImport 1) oox::xls::CellStyle::createStyle

oox::xls::StylesBuffer::writeStylesXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet
4) ScStyleObj::setPropertyValue

The oox::xls::CellStyle::createStyle is called 14,234 times, and the F+D: 21,419,377

----
In this solution:

1. if there are two same cell styles,named "style1" and "style2",
if a cell uses the second one,all the two cell styles will be created.

2. if there are two different cell styles, all the styles will be imported to spreadsheet.

3. if there are two same cell styles, but they are used by different cells,
all of them will be imported to spreadsheet.

4. if there are two same cell styles, and they are not used by any cell,
only import the first one to spreadsheet.

Calc/Performance/CellStylesOfOoxML

2012-09-21T03:35:14Z

Zhaoshzh:

Calc/Performance/CellStylesOfOoxML

2012-09-21T03:33:11Z

Zhaoshzh:

<noinclude>{{DISPLAYTITLE:Calc Performance Optimizations for CellStylesInOoxML}}</noinclude>

[[Category:Performance]]

If there are a lot of cell styles in MS 2007 .xlsx file, when loading the file in Aoo,
it will take about 20 seconds to create the cell styles.

After analyze the sample file, there are lots of duplicated cell style items in the
original file,and such file maybe created by script or other tools. So a method must
be used to get rid of the duplicated unused cell styles.

In MS 2007 .xlsx file,there are 3 items to record the cell style.
*cellStyleXfs

This element contains the master formatting records (xf's) which define the formatting for all named cell styles
in this workbook. Master formatting records reference individual elements of formatting (e.g., number format,
font definitions, cell fills, etc) by specifying a zero-based index into those collections. Master formatting records
also specify whether to apply or ignore particular aspects of formatting, for example whether to apply a border
or not.
*cellXfs

This element contains the master formatting records (xf) which define the formatting applied to cells in this
workbook. These records are the starting point for determining the formatting for a cell. Cells in the Sheet Part
reference the xf records by zero-based index.

*cellStyles
This element contains the named cell styles, consisting of a sequence of named style records. A named cell style
is a collection of direct or themed formatting (e.g., cell border, cell fill, and font type/size/style) grouped
together into a single named style, and can be applied to a cell.

Here is the relationship.

[[File:Cellstyle_relationship.JPG]]

Here is the result data by the rational purify.

Calls: 178,325
F+D: 25,128,429

Calls: 4,268
F+D: 24,404,739

1) ScCellRangesBase::setPropertyValues Calls: 45,336
F+D: 13,999,231

2) ScCellRangesBase::setPropertyValue Calls: 36,334
F+D: 8,745,959

3) ScStyleObj::setPropertyValues Calls: 28,282
F+D: 10,547,312

1)oox::xls::OoxSheetDataContext::onCreatContext 1) oox::xls::OoxSheetDataContext::importRow

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet

4) ScStyleObj::setPropertyValue Calls: 36,334

F+D: 8,745,959

Calls:178,308

F+D: 5,538,047

Calls: 158,771

F+D: 4,810,522

1) ScCellRangesBase::setPropertyValues

2) ScCellRangesBase::setPropertyValue

3) ScStyleObj::setPropertyValues

2)oox::xls::OoxSheetDataContext::onEndElement 1) oox::xls::WorksheetHelper::setCellFormat

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet
oox::xls::StylesBuffer::writeFillToPropertySet 4) ScStyleObj::setPropertyValue
Calls: 1
F+D: 21,475,924

Calls: 14,234

F+D: 21,419,377

1) ScCellRangesBase::setPropertyValues
2) ScCellRangesBase::setPropertyValue
3) ScStyleObj::setPropertyValues

3)oox::xls::OoxStylesFragement::finalizeImport 1) oox::xls::CellStyle::createStyle

oox::xls::StylesBuffer::writeStylesXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet
4) ScStyleObj::setPropertyValue

The oox::xls::CellStyle::createStyle is called 14,234 times, and the F+D: 21,419,377

----
In this solution:

1. if there are two same cell styles,named "style1" and "style2",
if a cell uses the second one,all the two cell styles will be created.

2. if there are two different cell styles, all the styles will be imported to spreadsheet.

3. if there are two same cell styles, but they are used by different cells,
all of them will be imported to spreadsheet.

4. if there are two same cell styles, and they are not used by any cell,
only import the first one to spreadsheet.

Calc/Performance/CellStylesOfOoxML

2012-09-21T03:31:00Z

Zhaoshzh:

If there are a lot of cell styles in MS 2007 .xlsx file, when loading the file in Aoo,
it will take about 20 seconds to create the cell styles.

After analyze the sample file, there are lots of duplicated cell style items in the
original file,and such file maybe created by script or other tools. So a method must
be used to get rid of the duplicated unused cell styles.

In MS 2007 .xlsx file,there are 3 items to record the cell style.
*cellStyleXfs

This element contains the master formatting records (xf's) which define the formatting for all named cell styles
in this workbook. Master formatting records reference individual elements of formatting (e.g., number format,
font definitions, cell fills, etc) by specifying a zero-based index into those collections. Master formatting records
also specify whether to apply or ignore particular aspects of formatting, for example whether to apply a border
or not.
*cellXfs

This element contains the master formatting records (xf) which define the formatting applied to cells in this
workbook. These records are the starting point for determining the formatting for a cell. Cells in the Sheet Part
reference the xf records by zero-based index.

*cellStyles
This element contains the named cell styles, consisting of a sequence of named style records. A named cell style
is a collection of direct or themed formatting (e.g., cell border, cell fill, and font type/size/style) grouped
together into a single named style, and can be applied to a cell.

Here is the relationship.

[[File:Cellstyle_relationship.JPG]]

Here is the result data by the rational purify.

Calls: 178,325
F+D: 25,128,429

Calls: 4,268
F+D: 24,404,739

1) ScCellRangesBase::setPropertyValues Calls: 45,336
F+D: 13,999,231

2) ScCellRangesBase::setPropertyValue Calls: 36,334
F+D: 8,745,959

3) ScStyleObj::setPropertyValues Calls: 28,282
F+D: 10,547,312

1)oox::xls::OoxSheetDataContext::onCreatContext 1) oox::xls::OoxSheetDataContext::importRow

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet

4) ScStyleObj::setPropertyValue Calls: 36,334

F+D: 8,745,959

Calls:178,308

F+D: 5,538,047

Calls: 158,771

F+D: 4,810,522

1) ScCellRangesBase::setPropertyValues

2) ScCellRangesBase::setPropertyValue

3) ScStyleObj::setPropertyValues

2)oox::xls::OoxSheetDataContext::onEndElement 1) oox::xls::WorksheetHelper::setCellFormat

oox::xls::WorksheetData::writeXfldRowRangeProperties

oox::xls::StylesBuffer::writeCellXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet
oox::xls::StylesBuffer::writeFillToPropertySet 4) ScStyleObj::setPropertyValue
Calls: 1
F+D: 21,475,924

Calls: 14,234

F+D: 21,419,377

1) ScCellRangesBase::setPropertyValues
2) ScCellRangesBase::setPropertyValue
3) ScStyleObj::setPropertyValues

3)oox::xls::OoxStylesFragement::finalizeImport 1) oox::xls::CellStyle::createStyle

oox::xls::StylesBuffer::writeStylesXfToPropertySet

oox::xls::StylesBuffer::writeFontToProperSet

oox::xls::StylesBuffer::writeBorderToProperSet

oox::xls::Allignment::writeToPropertySet

oox::xls::StylesBuffer::writeFillToPropertySet
4) ScStyleObj::setPropertyValue

The oox::xls::CellStyle::createStyle is called 14,234 times, and the F+D: 21,419,377

----
In this solution:

1. if there are two same cell styles,named "style1" and "style2",
if a cell uses the second one,all the two cell styles will be created.

2. if there are two different cell styles, all the styles will be imported to spreadsheet.

3. if there are two same cell styles, but they are used by different cells,
all of them will be imported to spreadsheet.

4. if there are two same cell styles, and they are not used by any cell,
only import the first one to spreadsheet.

File:Cellstyle relationship.JPG

2012-09-21T02:49:24Z

Zhaoshzh:

Calc/Performance/CellStylesOfOoxML

2012-09-21T02:47:53Z

Zhaoshzh:

Calc/Performance/CellStylesOfOoxML

2012-09-21T02:42:17Z

Zhaoshzh:

Calc/Performance/CellStylesOfOoxML

2012-09-21T02:40:12Z

Zhaoshzh: Created page with " If there are a lot of cell styles in MS 2007 .xlsx file, when loading the file in Aoo, it will take about 20 seconds to create the cell styles. After analyze the sample file, th…"

Calc/Features/Calc name range enchancement(step1)

2012-09-07T04:49:04Z

Zhaoshzh:

[[Category:Calc|Features/{{SUBPAGENAME}}]]
[[Category:Feature|{{SUBPAGENAME}}]]

{{bug|120478}}

MS Excel can support worksheet/workbook scope defined name. User can use same string to create new name if the 2 names are in different ranges.

[[File:Ms name range.JPG]]

When AOO loading a xlsx file which has duplicated defined name, AOO will only change the name. But any other place which use the defined name is not changed, which will cause problems. For example,in VBA project, if it used a name with “aaa” in the range of workbook,if there is also a name with “aaa” in the range of worksheet,Aoo will change the name to “aaa_1”. The reference to the second one will be changed to an invalid name. And it can be checked in the define names dialog, there are 2 items, one is “aaa” and the second is changed to “aaa_1”.

[[File:Old name range.JPG]]

This enchancemnet will support
(1)loading worksheet scope defined name from MS xlsx/xls and ods file.
(2)export defined name to MS xls(2003) and ods file.

if MS office defined range names with a sheet or a work book,import it in Aoo,
make the name of work sheet to the original,but with a flag of sheet name,for
example,the name is "aaa" in the range of work sheet, it will be "aaa (sheet1)" in the define name dialog , and the name “aaa” will be as its' original one if it is in the range of workbook.

[[File:New_name_range.JPG]]

Add functions in interface XNamedRange: com::sun::star::container::XNamed
<source lang="cpp">
1.string getScopeName();
//Return the name of the range.
2.void setScopeAndRangeName( [in] string aScopeName, [in] string aRangeName );
//Set the range name and the scope name.
</source>
Add functions in interface XNamedRanges: com::sun::star::container::XNameAccess
<source lang="cpp">
1. void addNewByScopeName(
[in] string aScopeName,
[in] string aRangeName,
[in] string aContent,
[in] com::sun::star::table::CellAddress aPosition,
[in] long nType );
//Add a scope named range to the name range list.
2. void removeByScopeName( [in] string aScopeName, [in] string aRangeName );
//Remove a defined range from the name range list.
3. boolean hasByScopeName( [in] string aScopeName, [in] string aRangeName );
//IF there is already a name range with name of aRangeName and the scope of aScopeName.
4. any getByScopeName( [in] string aScopeName, [in] string aRangeName )
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
//Return a name range by scope name and range name.
5.sequence<RangeScopeName> getElementScopeNames();
//Return all name ranges.
</blockquote>
</source>

The export content in xml file.

[[File:Namerange.JPG]]

If save a file to ODF file,the named range in a sheet will be added in the area of "<<[table:table]>>", the named range in a workbook will be added in the area of "<office:spreadsheet>".

What has been done in this item:

1. Support load duplicate names from MS 2003 file.

2. Support save duplicate names to MS 2003 file.

3. Support load duplicate names from MS 2007 file.

4. Support load duplicate names form ODF file.

5. Support save duplicate names to ODF file.

Limitation:

1. If a formula references a name that is defined in other workbook or a global range,

such formula can not be interpreted by Aoo.

2. Can not create duplicate named range in UI dialog.

Calc/Features/Calc name range enchancement(step1)

2012-09-07T04:47:19Z

Zhaoshzh:

Calc/Features/Calc name range enchancement(step1)

2012-08-31T09:02:57Z

Zhaoshzh:

[[Category:Calc|Features/{{SUBPAGENAME}}]]
[[Category:Feature|{{SUBPAGENAME}}]]

{{bug|120478}}

MS Excel can support worksheet/workbook scope defined name. User can use same string to create new name if the 2 names are in different ranges.

[[File:Ms name range.JPG]]

When AOO loading a xlsx file which has duplicated defined name, AOO will only change the name. But any other place which use the defined name is not changed, which will cause problems. For example,in VBA project, if it used a name with “aaa” in the range of workbook,if there is also a name with “aaa” in the range of worksheet,Aoo will change the name to “aaa_1”. The reference to the second one will be changed to an invalid name. And it can be checked in the define names dialog, there are 2 items, one is “aaa” and the second is changed to “aaa_1”.

[[File:Old name range.JPG]]

This enchancemnet will support
(1)loading worksheet scope defined name from MS xlsx/xls and ods file.
(2)export defined name to MS xls(2003) and ods file.

if MS office defined range names with a sheet or a work book,import it in Aoo,
make the name of work sheet to the original,but with a flag of sheet name,for
example,the name is "aaa" in the range of work sheet, it will be "aaa (sheet1)" in the define name dialog , and the name “aaa” will be as its' original one if it is in the range of workbook.

[[File:New_name_range.JPG]]

Add functions in interface XNamedRange: com::sun::star::container::XNamed
<source lang="cpp">
1.string getScopeName();
//Return the name of the range.
2.void setScopeAndRangeName( [in] string aScopeName, [in] string aRangeName );
//Set the range name and the scope name.
</source>
Add functions in interface XNamedRanges: com::sun::star::container::XNameAccess
<source lang="cpp">
1. void addNewByScopeName(
[in] string aScopeName,
[in] string aRangeName,
[in] string aContent,
[in] com::sun::star::table::CellAddress aPosition,
[in] long nType );
//Add a scope named range to the name range list.
2. void removeByScopeName( [in] string aScopeName, [in] string aRangeName );
//Remove a defined range from the name range list.
3. boolean hasByScopeName( [in] string aScopeName, [in] string aRangeName );
//IF there is already a name range with name of aRangeName and the scope of aScopeName.
4. any getByScopeName( [in] string aScopeName, [in] string aRangeName )
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
//Return a name range by scope name and range name.
5.sequence<RangeScopeName> getElementScopeNames();
//Return all name ranges.
</blockquote>
</source>

The export content in xml file.

[[File:Namerange.JPG]]

If save a file to ODF file,the named range in a sheet will be added in the area of "<<[table:table]>>", the named range in a workbook will be added in the area of "<office:spreadsheet>".

What has been done in this item:

1. Support load duplicate names from MS 2003 file.

2. Support save duplicate names to MS 2003 file.

3. Support load duplicate names from MS 2007 file.

4. Support load duplicate names form ODF file.

5. Support save duplicate names to ODF file.

Limitation:

1. If duplicate names are used in a formula,save file to ODF format,
the formula for the name("aaa") defined in a sheet is
of:=SUM(aaa)
the formula for the anme defined in a workbook is
of:=SUM(aaa)
if reload the exported file to Aoo,all will be marked as the name in a sheet.

2. If a formula references a name that is defined in other workbook,

load the file in Aoo,it will be displayed
as "#NAME?".

Calc/Features/Calc name range enchancement(step1)

2012-08-21T03:02:47Z

Zhaoshzh:

Calc/Features/Calc name range enchancement(step1)

2012-08-21T03:01:23Z

Zhaoshzh:

[[Category:Calc|Features/{{SUBPAGENAME}}]]
[[Category:Feature|{{SUBPAGENAME}}]]

MS Excel can support worksheet/workbook scope defined name. User can use same string to create new name if the 2 names are in different ranges.

[[File:Ms name range.JPG]]

When AOO loading a xlsx file which has duplicated defined name, AOO will only change the name. But any other place which use the defined name is not changed, which will cause problems. For example,in VBA project, if it used a name with “aaa” in the range of workbook,if there is also a name with “aaa” in the range of worksheet,Aoo will change the name to “aaa_1”. The reference to the second one will be changed to an invalid name. And it can be checked in the define names dialog, there are 2 items, one is “aaa” and the second is changed to “aaa_1”.

[[File:Old name range.JPG]]

This enchancemnet will support
(1)loading worksheet scope defined name from MS xlsx/xls and ods file.
(2)export defined name to MS xls(2003) and ods file.

if MS office defined range names with a sheet or a work book,import it in Aoo,
make the name of work sheet to the original,but with a flag of sheet name,for
example,the name is "aaa" in the range of work sheet, it will be "aaa (sheet1)" in the define name dialog , and the name “aaa” will be as its' original one if it is in the range of workbook.

[[File:New_name_range.JPG]]

Add functions in interface XNamedRange: com::sun::star::container::XNamed
<source lang="cpp">
1.string getScopeName();
//Return the name of the range.
2.void setScopeAndRangeName( [in] string aScopeName, [in] string aRangeName );
//Set the range name and the scope name.
</source>
Add functions in interface XNamedRanges: com::sun::star::container::XNameAccess
<source lang="cpp">
1. void addNewByScopeName(
[in] string aScopeName,
[in] string aRangeName,
[in] string aContent,
[in] com::sun::star::table::CellAddress aPosition,
[in] long nType );
//Add a scope named range to the name range list.
2. void removeByScopeName( [in] string aScopeName, [in] string aRangeName );
//Remove a defined range from the name range list.
3. boolean hasByScopeName( [in] string aScopeName, [in] string aRangeName );
//IF there is already a name range with name of aRangeName and the scope of aScopeName.
4. any getByScopeName( [in] string aScopeName, [in] string aRangeName )
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
//Return a name range by scope name and range name.
5.sequence<RangeScopeName> getElementScopeNames();
//Return all name ranges.
</blockquote>
</source>

The export content in xml file.

[[File:Namerange.JPG]]

If save a file to ODF file,the named range in a sheet will be added in the area of "<<[table:table]>>", the named range in a workbook will be added in the area of "<office:spreadsheet>".

Calc/Features/Calc name range enchancement(step1)

2012-08-21T02:58:47Z

Zhaoshzh:

[[Category:Calc]]
[[Category:Features]]

MS Excel can support worksheet/workbook scope defined name. User can use same string to create new name if the 2 names are in different ranges.

[[File:Ms name range.JPG]]

When AOO loading a xlsx file which has duplicated defined name, AOO will only change the name. But any other place which use the defined name is not changed, which will cause problems. For example,in VBA project, if it used a name with “aaa” in the range of workbook,if there is also a name with “aaa” in the range of worksheet,Aoo will change the name to “aaa_1”. The reference to the second one will be changed to an invalid name. And it can be checked in the define names dialog, there are 2 items, one is “aaa” and the second is changed to “aaa_1”.

[[File:Old name range.JPG]]

This enchancemnet will support
(1)loading worksheet scope defined name from MS xlsx/xls and ods file.
(2)export defined name to MS xls(2003) and ods file.

if MS office defined range names with a sheet or a work book,import it in Aoo,
make the name of work sheet to the original,but with a flag of sheet name,for
example,the name is "aaa" in the range of work sheet, it will be "aaa (sheet1)" in the define name dialog , and the name “aaa” will be as its' original one if it is in the range of workbook.

[[File:New_name_range.JPG]]

Add functions in interface XNamedRange: com::sun::star::container::XNamed
<source lang="cpp">
1.string getScopeName();
//Return the name of the range.
2.void setScopeAndRangeName( [in] string aScopeName, [in] string aRangeName );
//Set the range name and the scope name.
</source>
Add functions in interface XNamedRanges: com::sun::star::container::XNameAccess
<source lang="cpp">
1. void addNewByScopeName(
[in] string aScopeName,
[in] string aRangeName,
[in] string aContent,
[in] com::sun::star::table::CellAddress aPosition,
[in] long nType );
//Add a scope named range to the name range list.
2. void removeByScopeName( [in] string aScopeName, [in] string aRangeName );
//Remove a defined range from the name range list.
3. boolean hasByScopeName( [in] string aScopeName, [in] string aRangeName );
//IF there is already a name range with name of aRangeName and the scope of aScopeName.
4. any getByScopeName( [in] string aScopeName, [in] string aRangeName )
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
//Return a name range by scope name and range name.
5.sequence<RangeScopeName> getElementScopeNames();
//Return all name ranges.
</blockquote>
</source>

The export content in xml file.

[[File:Namerange.JPG]]

If save a file to ODF file,the named range in a sheet will be added in the area of "<<[table:table]>>", the named range in a workbook will be added in the area of "<office:spreadsheet>".

Calc/Implementation/Calc name range enchancement(step1)

2012-08-21T02:56:49Z

Zhaoshzh: moved Calc/Implementation/Calc name range enchancement(step1) to Calc/Features/Calc name range enchancement(step1)

#REDIRECT [[Calc/Features/Calc name range enchancement(step1)]]

Calc/Features/Calc name range enchancement(step1)

2012-08-21T02:56:49Z

Zhaoshzh: moved Calc/Implementation/Calc name range enchancement(step1) to Calc/Features/Calc name range enchancement(step1)

[[Category:Calc]]
[[Category:Implementation]]

MS Excel can support worksheet/workbook scope defined name. User can use same string to create new name if the 2 names are in different ranges.

[[File:Ms name range.JPG]]

When AOO loading a xlsx file which has duplicated defined name, AOO will only change the name. But any other place which use the defined name is not changed, which will cause problems. For example,in VBA project, if it used a name with “aaa” in the range of workbook,if there is also a name with “aaa” in the range of worksheet,Aoo will change the name to “aaa_1”. The reference to the second one will be changed to an invalid name. And it can be checked in the define names dialog, there are 2 items, one is “aaa” and the second is changed to “aaa_1”.

[[File:Old name range.JPG]]

This enchancemnet will support
(1)loading worksheet scope defined name from MS xlsx/xls and ods file.
(2)export defined name to MS xls(2003) and ods file.

if MS office defined range names with a sheet or a work book,import it in Aoo,
make the name of work sheet to the original,but with a flag of sheet name,for
example,the name is "aaa" in the range of work sheet, it will be "aaa (sheet1)" in the define name dialog , and the name “aaa” will be as its' original one if it is in the range of workbook.

[[File:New_name_range.JPG]]

Add functions in interface XNamedRange: com::sun::star::container::XNamed
<source lang="cpp">
1.string getScopeName();
//Return the name of the range.
2.void setScopeAndRangeName( [in] string aScopeName, [in] string aRangeName );
//Set the range name and the scope name.
</source>
Add functions in interface XNamedRanges: com::sun::star::container::XNameAccess
<source lang="cpp">
1. void addNewByScopeName(
[in] string aScopeName,
[in] string aRangeName,
[in] string aContent,
[in] com::sun::star::table::CellAddress aPosition,
[in] long nType );
//Add a scope named range to the name range list.
2. void removeByScopeName( [in] string aScopeName, [in] string aRangeName );
//Remove a defined range from the name range list.
3. boolean hasByScopeName( [in] string aScopeName, [in] string aRangeName );
//IF there is already a name range with name of aRangeName and the scope of aScopeName.
4. any getByScopeName( [in] string aScopeName, [in] string aRangeName )
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
//Return a name range by scope name and range name.
5.sequence<RangeScopeName> getElementScopeNames();
//Return all name ranges.
</blockquote>
</source>

The export content in xml file.

[[File:Namerange.JPG]]

If save a file to ODF file,the named range in a sheet will be added in the area of "<<[table:table]>>", the named range in a workbook will be added in the area of "<office:spreadsheet>".

Calc/Features/Calc name range enchancement(step1)

2012-08-21T02:55:47Z

Zhaoshzh:

File:Namerange.JPG

2012-08-21T02:47:58Z

Zhaoshzh:

Calc/Implementation/Calc name range enchancement

2012-08-14T07:28:24Z

Zhaoshzh: moved Calc/Implementation/Calc name range enchancement to Calc/Implementation/Calc name range enchancement(step1)

#REDIRECT [[Calc/Implementation/Calc name range enchancement(step1)]]

Calc/Features/Calc name range enchancement(step1)

2012-08-14T07:28:24Z

Zhaoshzh: moved Calc/Implementation/Calc name range enchancement to Calc/Implementation/Calc name range enchancement(step1)

Calc/Features/Calc name range enchancement(step1)

2012-08-14T07:06:37Z

Zhaoshzh:

Calc/Features/Calc name range enchancement(step1)

2012-08-14T07:03:13Z

Zhaoshzh: Created page with "MS Excel can support worksheet/workbook scope defined name. User can use same string to create new name if the 2 names are in different ranges. File:Ms name range.JPG When …"

MS Excel can support worksheet/workbook scope defined name. User can use same string to create new name if the 2 names are in different ranges.

[[File:Ms name range.JPG]]

When AOO loading a xlsx file which has duplicated defined name, AOO will only change the name. But any other place which use the defined name is not changed, which will cause problems. For example,in VBA project, if it used a name with “aaa” in the range of workbook,if there is also a name with “aaa” in the range of worksheet,Aoo will change the name to “aaa_1”. The reference to the second one will be changed to an invalid name. And it can be checked in the define names dialog, there are 2 items, one is “aaa” and the second is changed to “aaa_1”.

[[File:Old name range.JPG]]

This enchancemnet will support
(1)loading worksheet scope defined name from MS xlsx/xls and ods file.
(2)export defined name to MS xls(2003) and ods file.

if MS office defined range names with a sheet or a work book,import it in Aoo,
make the name of work sheet to the original,but with a flag of sheet name,for
example,the name is "aaa" in the range of work sheet, it will be "aaa (sheet1)" in the define name dialog , and the name “aaa” will be as its' original one if it is in the range of workbook.

[[File:New_name_range.JPG]]

Add functions in interface XNamedRange: com::sun::star::container::XNamed
<source lang="cpp">
1.string getScopeName();
//Return the name of the range.
2.void setScopeAndRangeName( [in] string aScopeName, [in] string aRangeName );
//Set the range name and the scope name.
</source>
Add functions in interface XNamedRanges: com::sun::star::container::XNameAccess
<source lang="cpp">
1. void addNewByScopeName(
[in] string aScopeName,
[in] string aRangeName,
[in] string aContent,
[in] com::sun::star::table::CellAddress aPosition,
[in] long nType );
//Add a scope named range to the name range list.
2. void removeByScopeName( [in] string aScopeName, [in] string aRangeName );
//Remove a defined range from the name range list.
3. boolean hasByScopeName( [in] string aScopeName, [in] string aRangeName );
//IF there is already a name range with name of aRangeName and the scope of aScopeName.
4. any getByScopeName( [in] string aScopeName, [in] string aRangeName )
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
//Return a name range by scope name and range name.
5.sequence<RangeScopeName> getElementScopeNames();
//Return all name ranges.
</blockquote>
</source>

File:New name range.JPG

2012-08-14T06:53:39Z

Zhaoshzh:

File:Old name range.JPG

2012-08-14T06:52:49Z

Zhaoshzh:

File:Ms name range.JPG

2012-08-14T06:51:19Z

Zhaoshzh: Ms_name_range

Ms_name_range

Calc/Implementation/Filter in spreadsheet

2012-06-01T06:25:36Z

Zhaoshzh:

[[Category:Calc]]
[[Category:Implementation]]

== The whole view of filter ==
An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must turn the latter into the former as shown by this diagram.

[[File:Filter_structure.JPG]]

== Filter in symphony ==
When open a file in symphony, the supported filters will be initialized by the class of SfxFilterContainer in sfx2\inc\sfx2.
It contains a member of SfxFilterContainer_Impl *pImpl. Symphony uses this class to control every SfxFilter.

[[File:SfxFilterContainer.JPG]]

There are a global variable for storing SfxFilter, the name is
static SfxFilterList_Impl* pFilterArr = 0;
it is defined in sfx2\source\bastyp\fltfnc.cxx.
Indeed SfxFilterList_Impl is a list defined by DECLARE_LIST( SfxFilterList_Impl, SfxFilter* ) in sfx2\inc\arrdecl.hxx.
The detail can be traced by the call stack.
[[File:Callstack.JPG]]
== Get the correct filter to load a document ==
To import a real document, symphony should get the file type to use the correct filter.
To get the filter, Symphony will use flat detection and deep detection.
In few words the "flat detection" is a type detection based on document extension, for example,a document named "test.xls", it will get calc to load it by the extension of "xls".
The "deep detection" is the detection that analyzes the document contents. For example, if a document named "test.xls",but it is presentation document, then the deep detection should be joined.
In the file of filter\source\config\cache\typedetection.cxx, the function of
TypeDetection::queryTypeByDescriptor is the entry for getting the filter to loading the document.
*Flat detection
FilterCache::detectFlatForURL, it can get the correct filter by the extention of the document name.
The function is defined in filter\source\config\cache\filtercache.cxx
A subset of document types is defined for a real filter. For example, to calc, it is defined in Basis\share\registry\modules\org\openoffice\TypeDetection\Filter\fcfg_calc_filters.xcu, here is an item for MS excel 97 file format.

<node oor:name="MS Excel 97" oor:op="replace">

<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN PREFERRED</value></prop>

<prop oor:name="UIComponent"/>

<prop oor:name="FilterService"/>

<prop oor:name="UserData"/>

<prop oor:name="UIName">

<value xml:lang="x-default">Microsoft Excel 97/2000/XP</value>

</prop>

<prop oor:name="FileFormatVersion"><value>0</value></prop>

<prop oor:name="Type"><value>calc_MS_Excel_97</value></prop>

<prop oor:name="TemplateName"/>

<prop oor:name="DocumentService"><value>com.sun.star.sheet.SpreadsheetDocument</value></prop>

</node>

The UIName defines the string of MS excel 97 displayed for open/save dialog.
The Type defines the string used in the internal code of Symphony.
The DocumentService defines which service is used to import/export such document.

[[File:Callstack2.JPG]]

*Deep detection
Symphony uses the interface XExtendedFilterDetection to look into the document stream to detect the format. It belongs to :: com :: sun :: star :: document.
This function is called by TypeDetection::impl_askDetectService
in the file filter\source\config\cache\typedetection.cxx
sDeepType = xDetector->detect(lDescriptor);
In the step 3.1, Symphony has got the filters by the file's extention.
The types matching to the given extention.
Calc_MS_Excel_40
Calc_MS_Excel_95
Calc_MS_Excel_97
Calc_Text_txt_csv_StarCalc
Calc_MS_Excel_5095
By the types, Symphony will do the deep detection. It is realized by a spreadsheet servcie of
com.sun.star.comp.calc.FormatDetector.

In the function of TypeDetection::impl_askDetectService(), It
calls xDetector->detect(lDescriptor);
The real implement function is ScFilterDetect::detect()
It is defined in sc\source\ui\unoobj\scdetect.cxx
At first, make a SotStorage by the input stream of MS excel
SotStorageRef aStorage = new SotStorage ( pStream, FALSE );
Then check the content of the file, if there is a sub stream named "Workbook" or "Book".
String aStreamName(RTL_CONSTASCII_STRINGPARAM("Workbook"));
BOOL bExcel97Stream = ( aStorage->IsStream( aStreamName ) );

aStreamName = String(RTL_CONSTASCII_STRINGPARAM("Book"));
BOOL bExcel5Stream = ( aStorage->IsStream( aStreamName ) );
[[File:deepdetect.jpg]]
*Load a chart in spreadsheet filter
Chart is managed by the class of XclImpObjectManager in spreadsheet. The real implement is XclImpChartObj that is base on XclImplDrawObjBase.
XclImpChart will import the parts of chart, for example, diagram, series, title, background, etc.

[[File:Loadchart.JPG]]

Calc/Implementation/Filter

2012-06-01T06:24:15Z

Zhaoshzh: moved Calc/Implementation/Filter to Calc/Implementation/Filter in spreadsheet

#REDIRECT [[Calc/Implementation/Filter in spreadsheet]]

Calc/Implementation/Filter in spreadsheet

2012-06-01T06:24:15Z

Zhaoshzh: moved Calc/Implementation/Filter to Calc/Implementation/Filter in spreadsheet

[[Category:Calc]]
[[Category:Implementation]]

== The whole view of filter ==
An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must turn the latter into the former as shown by this diagram.

[[File:Filter_structure.JPG]]

== Filter in symphony ==
When open a file in symphony, the supported filters will be initialized by the class of SfxFilterContainer in sfx2\inc\sfx2.
It contains a member of SfxFilterContainer_Impl *pImpl. Symphony uses this class to control every SfxFilter.

[[File:SfxFilterContainer.JPG]]

There are a global variable for storing SfxFilter, the name is
static SfxFilterList_Impl* pFilterArr = 0;
it is defined in sfx2\source\bastyp\fltfnc.cxx.
Indeed SfxFilterList_Impl is a list defined by DECLARE_LIST( SfxFilterList_Impl, SfxFilter* ) in sfx2\inc\arrdecl.hxx.
The detail can be traced by the call stack.
[[File:Callstack.JPG]]
== Get the correct filter to load a document ==
To import a real document, symphony should get the file type to use the correct filter.
To get the filter, Symphony will use flat detection and deep detection.
In few words the "flat detection" is a type detection based on document extension, for example,a document named "test.xls", it will get calc to load it by the extension of "xls".
The "deep detection" is the detection that analyzes the document contents. For example, if a document named "test.xls",but it is presentation document, then the deep detection should be joined.
In the file of filter\source\config\cache\typedetection.cxx, the function of
TypeDetection::queryTypeByDescriptor is the entry for getting the filter to loading the document.
*Flat detection
FilterCache::detectFlatForURL, it can get the correct filter by the extention of the document name.
The function is defined in filter\source\config\cache\filtercache.cxx
A subset of document types is defined for a real filter. For example, to calc, it is defined in Basis\share\registry\modules\org\openoffice\TypeDetection\Filter\fcfg_calc_filters.xcu, here is an item for MS excel 97 file format.
<node oor:name="MS Excel 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN PREFERRED</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"/>
<prop oor:name="UserData"/>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Excel 97/2000/XP</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>calc_MS_Excel_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.sheet.SpreadsheetDocument</value></prop>
</node>
The UIName defines the string of MS excel 97 displayed for open/save dialog.
The Type defines the string used in the internal code of Symphony.
The DocumentService defines which service is used to import/export such document.

[[File:Callstack2.JPG]]

*Deep detection
Symphony uses the interface XExtendedFilterDetection to look into the document stream to detect the format. It belongs to :: com :: sun :: star :: document.
This function is called by TypeDetection::impl_askDetectService
in the file filter\source\config\cache\typedetection.cxx
sDeepType = xDetector->detect(lDescriptor);
In the step 3.1, Symphony has got the filters by the file's extention.
The types matching to the given extention.
Calc_MS_Excel_40
Calc_MS_Excel_95
Calc_MS_Excel_97
Calc_Text_txt_csv_StarCalc
Calc_MS_Excel_5095
By the types, Symphony will do the deep detection. It is realized by a spreadsheet servcie of
com.sun.star.comp.calc.FormatDetector.

In the function of TypeDetection::impl_askDetectService(), It
calls xDetector->detect(lDescriptor);
The real implement function is ScFilterDetect::detect()
It is defined in sc\source\ui\unoobj\scdetect.cxx
At first, make a SotStorage by the input stream of MS excel
SotStorageRef aStorage = new SotStorage ( pStream, FALSE );
Then check the content of the file, if there is a sub stream named "Workbook" or "Book".
String aStreamName(RTL_CONSTASCII_STRINGPARAM("Workbook"));
BOOL bExcel97Stream = ( aStorage->IsStream( aStreamName ) );

aStreamName = String(RTL_CONSTASCII_STRINGPARAM("Book"));
BOOL bExcel5Stream = ( aStorage->IsStream( aStreamName ) );
[[File:deepdetect.jpg]]
*Load a chart in spreadsheet filter
Chart is managed by the class of XclImpObjectManager in spreadsheet. The real implement is XclImpChartObj that is base on XclImplDrawObjBase.
XclImpChart will import the parts of chart, for example, diagram, series, title, background, etc.

[[File:Loadchart.JPG]]

Calc/Implementation/Filter in spreadsheet

2012-06-01T02:15:39Z

Zhaoshzh:

[[Category:Calc]]
[[Category:Implementation]]

== The whole view of filter ==
An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must turn the latter into the former as shown by this diagram.

[[File:Filter_structure.JPG]]

== Filter in symphony ==
When open a file in symphony, the supported filters will be initialized by the class of SfxFilterContainer in sfx2\inc\sfx2.
It contains a member of SfxFilterContainer_Impl *pImpl. Symphony uses this class to control every SfxFilter.

[[File:SfxFilterContainer.JPG]]

There are a global variable for storing SfxFilter, the name is
static SfxFilterList_Impl* pFilterArr = 0;
it is defined in sfx2\source\bastyp\fltfnc.cxx.
Indeed SfxFilterList_Impl is a list defined by DECLARE_LIST( SfxFilterList_Impl, SfxFilter* ) in sfx2\inc\arrdecl.hxx.
The detail can be traced by the call stack.
[[File:Callstack.JPG]]
== Get the correct filter to load a document ==
To import a real document, symphony should get the file type to use the correct filter.
To get the filter, Symphony will use flat detection and deep detection.
In few words the "flat detection" is a type detection based on document extension, for example,a document named "test.xls", it will get calc to load it by the extension of "xls".
The "deep detection" is the detection that analyzes the document contents. For example, if a document named "test.xls",but it is presentation document, then the deep detection should be joined.
In the file of filter\source\config\cache\typedetection.cxx, the function of
TypeDetection::queryTypeByDescriptor is the entry for getting the filter to loading the document.
*Flat detection
FilterCache::detectFlatForURL, it can get the correct filter by the extention of the document name.
The function is defined in filter\source\config\cache\filtercache.cxx
A subset of document types is defined for a real filter. For example, to calc, it is defined in Basis\share\registry\modules\org\openoffice\TypeDetection\Filter\fcfg_calc_filters.xcu, here is an item for MS excel 97 file format.
<node oor:name="MS Excel 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN PREFERRED</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"/>
<prop oor:name="UserData"/>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Excel 97/2000/XP</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>calc_MS_Excel_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.sheet.SpreadsheetDocument</value></prop>
</node>
The UIName defines the string of MS excel 97 displayed for open/save dialog.
The Type defines the string used in the internal code of Symphony.
The DocumentService defines which service is used to import/export such document.

[[File:Callstack2.JPG]]

*Deep detection
Symphony uses the interface XExtendedFilterDetection to look into the document stream to detect the format. It belongs to :: com :: sun :: star :: document.
This function is called by TypeDetection::impl_askDetectService
in the file filter\source\config\cache\typedetection.cxx
sDeepType = xDetector->detect(lDescriptor);
In the step 3.1, Symphony has got the filters by the file's extention.
The types matching to the given extention.
Calc_MS_Excel_40
Calc_MS_Excel_95
Calc_MS_Excel_97
Calc_Text_txt_csv_StarCalc
Calc_MS_Excel_5095
By the types, Symphony will do the deep detection. It is realized by a spreadsheet servcie of
com.sun.star.comp.calc.FormatDetector.

In the function of TypeDetection::impl_askDetectService(), It
calls xDetector->detect(lDescriptor);
The real implement function is ScFilterDetect::detect()
It is defined in sc\source\ui\unoobj\scdetect.cxx
At first, make a SotStorage by the input stream of MS excel
SotStorageRef aStorage = new SotStorage ( pStream, FALSE );
Then check the content of the file, if there is a sub stream named "Workbook" or "Book".
String aStreamName(RTL_CONSTASCII_STRINGPARAM("Workbook"));
BOOL bExcel97Stream = ( aStorage->IsStream( aStreamName ) );

aStreamName = String(RTL_CONSTASCII_STRINGPARAM("Book"));
BOOL bExcel5Stream = ( aStorage->IsStream( aStreamName ) );
[[File:deepdetect.jpg]]
*Load a chart in spreadsheet filter
Chart is managed by the class of XclImpObjectManager in spreadsheet. The real implement is XclImpChartObj that is base on XclImplDrawObjBase.
XclImpChart will import the parts of chart, for example, diagram, series, title, background, etc.

[[File:Loadchart.JPG]]

Calc/Implementation/Filter in spreadsheet

2012-06-01T02:13:33Z

Zhaoshzh: (checkpoint save)

== The whole view of filter ==
An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must turn the latter into the former as shown by this diagram.

[[File:Filter_structure.JPG]]

== Filter in symphony ==
When open a file in symphony, the supported filters will be initialized by the class of SfxFilterContainer in sfx2\inc\sfx2.
It contains a member of SfxFilterContainer_Impl *pImpl. Symphony uses this class to control every SfxFilter.

[[File:SfxFilterContainer.JPG]]

There are a global variable for storing SfxFilter, the name is
static SfxFilterList_Impl* pFilterArr = 0;
it is defined in sfx2\source\bastyp\fltfnc.cxx.
Indeed SfxFilterList_Impl is a list defined by DECLARE_LIST( SfxFilterList_Impl, SfxFilter* ) in sfx2\inc\arrdecl.hxx.
The detail can be traced by the call stack.
[[File:Callstack.JPG]]
== Get the correct filter to load a document ==
To import a real document, symphony should get the file type to use the correct filter.
To get the filter, Symphony will use flat detection and deep detection.
In few words the "flat detection" is a type detection based on document extension, for example,a document named "test.xls", it will get calc to load it by the extension of "xls".
The "deep detection" is the detection that analyzes the document contents. For example, if a document named "test.xls",but it is presentation document, then the deep detection should be joined.
In the file of filter\source\config\cache\typedetection.cxx, the function of
TypeDetection::queryTypeByDescriptor is the entry for getting the filter to loading the document.
*Flat detection
FilterCache::detectFlatForURL, it can get the correct filter by the extention of the document name.
The function is defined in filter\source\config\cache\filtercache.cxx
A subset of document types is defined for a real filter. For example, to calc, it is defined in Basis\share\registry\modules\org\openoffice\TypeDetection\Filter\fcfg_calc_filters.xcu, here is an item for MS excel 97 file format.
<node oor:name="MS Excel 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN PREFERRED</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"/>
<prop oor:name="UserData"/>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Excel 97/2000/XP</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>calc_MS_Excel_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.sheet.SpreadsheetDocument</value></prop>
</node>
The UIName defines the string of MS excel 97 displayed for open/save dialog.
The Type defines the string used in the internal code of Symphony.
The DocumentService defines which service is used to import/export such document.

[[File:Callstack2.JPG]]

*Deep detection
Symphony uses the interface XExtendedFilterDetection to look into the document stream to detect the format. It belongs to :: com :: sun :: star :: document.
This function is called by TypeDetection::impl_askDetectService
in the file filter\source\config\cache\typedetection.cxx
sDeepType = xDetector->detect(lDescriptor);
In the step 3.1, Symphony has got the filters by the file's extention.
The types matching to the given extention.
Calc_MS_Excel_40
Calc_MS_Excel_95
Calc_MS_Excel_97
Calc_Text_txt_csv_StarCalc
Calc_MS_Excel_5095
By the types, Symphony will do the deep detection. It is realized by a spreadsheet servcie of
com.sun.star.comp.calc.FormatDetector.

In the function of TypeDetection::impl_askDetectService(), It
calls xDetector->detect(lDescriptor);
The real implement function is ScFilterDetect::detect()
It is defined in sc\source\ui\unoobj\scdetect.cxx
At first, make a SotStorage by the input stream of MS excel
SotStorageRef aStorage = new SotStorage ( pStream, FALSE );
Then check the content of the file, if there is a sub stream named "Workbook" or "Book".
String aStreamName(RTL_CONSTASCII_STRINGPARAM("Workbook"));
BOOL bExcel97Stream = ( aStorage->IsStream( aStreamName ) );

aStreamName = String(RTL_CONSTASCII_STRINGPARAM("Book"));
BOOL bExcel5Stream = ( aStorage->IsStream( aStreamName ) );
[[File:deepdetect.jpg]]
*Load a chart in spreadsheet filter
Chart is managed by the class of XclImpObjectManager in spreadsheet. The real implement is XclImpChartObj that is base on XclImplDrawObjBase.
XclImpChart will import the parts of chart, for example, diagram, series, title, background, etc.

[[File:Loadchart.JPG]]

Calc/Implementation/Filter in spreadsheet

2012-06-01T02:13:05Z

Zhaoshzh: (checkpoint save)

== The whole view of filter ==
An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must turn the latter into the former as shown by this diagram.
[[File:Filter_structure.JPG]]
== Filter in symphony ==
When open a file in symphony, the supported filters will be initialized by the class of SfxFilterContainer in sfx2\inc\sfx2.
It contains a member of SfxFilterContainer_Impl *pImpl. Symphony uses this class to control every SfxFilter.

[[File:SfxFilterContainer.JPG]]

There are a global variable for storing SfxFilter, the name is
static SfxFilterList_Impl* pFilterArr = 0;
it is defined in sfx2\source\bastyp\fltfnc.cxx.
Indeed SfxFilterList_Impl is a list defined by DECLARE_LIST( SfxFilterList_Impl, SfxFilter* ) in sfx2\inc\arrdecl.hxx.
The detail can be traced by the call stack.
[[File:Callstack.JPG]]
== Get the correct filter to load a document ==
To import a real document, symphony should get the file type to use the correct filter.
To get the filter, Symphony will use flat detection and deep detection.
In few words the "flat detection" is a type detection based on document extension, for example,a document named "test.xls", it will get calc to load it by the extension of "xls".
The "deep detection" is the detection that analyzes the document contents. For example, if a document named "test.xls",but it is presentation document, then the deep detection should be joined.
In the file of filter\source\config\cache\typedetection.cxx, the function of
TypeDetection::queryTypeByDescriptor is the entry for getting the filter to loading the document.
*Flat detection
FilterCache::detectFlatForURL, it can get the correct filter by the extention of the document name.
The function is defined in filter\source\config\cache\filtercache.cxx
A subset of document types is defined for a real filter. For example, to calc, it is defined in Basis\share\registry\modules\org\openoffice\TypeDetection\Filter\fcfg_calc_filters.xcu, here is an item for MS excel 97 file format.
<node oor:name="MS Excel 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN PREFERRED</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"/>
<prop oor:name="UserData"/>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Excel 97/2000/XP</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>calc_MS_Excel_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.sheet.SpreadsheetDocument</value></prop>
</node>
The UIName defines the string of MS excel 97 displayed for open/save dialog.
The Type defines the string used in the internal code of Symphony.
The DocumentService defines which service is used to import/export such document.
[[File:Callstack2.JPG]]
*Deep detection
Symphony uses the interface XExtendedFilterDetection to look into the document stream to detect the format. It belongs to :: com :: sun :: star :: document.
This function is called by TypeDetection::impl_askDetectService
in the file filter\source\config\cache\typedetection.cxx
sDeepType = xDetector->detect(lDescriptor);
In the step 3.1, Symphony has got the filters by the file's extention.
The types matching to the given extention.
Calc_MS_Excel_40
Calc_MS_Excel_95
Calc_MS_Excel_97
Calc_Text_txt_csv_StarCalc
Calc_MS_Excel_5095
By the types, Symphony will do the deep detection. It is realized by a spreadsheet servcie of
com.sun.star.comp.calc.FormatDetector.

In the function of TypeDetection::impl_askDetectService(), It
calls xDetector->detect(lDescriptor);
The real implement function is ScFilterDetect::detect()
It is defined in sc\source\ui\unoobj\scdetect.cxx
At first, make a SotStorage by the input stream of MS excel
SotStorageRef aStorage = new SotStorage ( pStream, FALSE );
Then check the content of the file, if there is a sub stream named "Workbook" or "Book".
String aStreamName(RTL_CONSTASCII_STRINGPARAM("Workbook"));
BOOL bExcel97Stream = ( aStorage->IsStream( aStreamName ) );

aStreamName = String(RTL_CONSTASCII_STRINGPARAM("Book"));
BOOL bExcel5Stream = ( aStorage->IsStream( aStreamName ) );
[[File:deepdetect.jpg]]
*Load a chart in spreadsheet filter
Chart is managed by the class of XclImpObjectManager in spreadsheet. The real implement is XclImpChartObj that is base on XclImplDrawObjBase.
XclImpChart will import the parts of chart, for example, diagram, series, title, background, etc.
[[File:Loadchart.JPG]]

Calc/Implementation/Filter in spreadsheet

2012-06-01T02:12:25Z

Zhaoshzh: (checkpoint save)

== The whole view of filter ==
An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must turn the latter into the former as shown by this diagram.
[[File:Filter_structure.JPG]]
== Filter in symphony ==
When open a file in symphony, the supported filters will be initialized by the class of SfxFilterContainer in sfx2\inc\sfx2.
It contains a member of SfxFilterContainer_Impl *pImpl. Symphony uses this class to control every SfxFilter.
[[File:SfxFilterContainer.JPG]]
There are a global variable for storing SfxFilter, the name is
static SfxFilterList_Impl* pFilterArr = 0;
it is defined in sfx2\source\bastyp\fltfnc.cxx.
Indeed SfxFilterList_Impl is a list defined by DECLARE_LIST( SfxFilterList_Impl, SfxFilter* ) in sfx2\inc\arrdecl.hxx.
The detail can be traced by the call stack.
[[File:Callstack.JPG]]
== Get the correct filter to load a document ==
To import a real document, symphony should get the file type to use the correct filter.
To get the filter, Symphony will use flat detection and deep detection.
In few words the "flat detection" is a type detection based on document extension, for example,a document named "test.xls", it will get calc to load it by the extension of "xls".
The "deep detection" is the detection that analyzes the document contents. For example, if a document named "test.xls",but it is presentation document, then the deep detection should be joined.
In the file of filter\source\config\cache\typedetection.cxx, the function of
TypeDetection::queryTypeByDescriptor is the entry for getting the filter to loading the document.
*Flat detection
FilterCache::detectFlatForURL, it can get the correct filter by the extention of the document name.
The function is defined in filter\source\config\cache\filtercache.cxx
A subset of document types is defined for a real filter. For example, to calc, it is defined in Basis\share\registry\modules\org\openoffice\TypeDetection\Filter\fcfg_calc_filters.xcu, here is an item for MS excel 97 file format.
<node oor:name="MS Excel 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN PREFERRED</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"/>
<prop oor:name="UserData"/>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Excel 97/2000/XP</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>calc_MS_Excel_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.sheet.SpreadsheetDocument</value></prop>
</node>
The UIName defines the string of MS excel 97 displayed for open/save dialog.
The Type defines the string used in the internal code of Symphony.
The DocumentService defines which service is used to import/export such document.
[[File:Callstack2.JPG]]
*Deep detection
Symphony uses the interface XExtendedFilterDetection to look into the document stream to detect the format. It belongs to :: com :: sun :: star :: document.
This function is called by TypeDetection::impl_askDetectService
in the file filter\source\config\cache\typedetection.cxx
sDeepType = xDetector->detect(lDescriptor);
In the step 3.1, Symphony has got the filters by the file's extention.
The types matching to the given extention.
Calc_MS_Excel_40
Calc_MS_Excel_95
Calc_MS_Excel_97
Calc_Text_txt_csv_StarCalc
Calc_MS_Excel_5095
By the types, Symphony will do the deep detection. It is realized by a spreadsheet servcie of
com.sun.star.comp.calc.FormatDetector.

In the function of TypeDetection::impl_askDetectService(), It
calls xDetector->detect(lDescriptor);
The real implement function is ScFilterDetect::detect()
It is defined in sc\source\ui\unoobj\scdetect.cxx
At first, make a SotStorage by the input stream of MS excel
SotStorageRef aStorage = new SotStorage ( pStream, FALSE );
Then check the content of the file, if there is a sub stream named "Workbook" or "Book".
String aStreamName(RTL_CONSTASCII_STRINGPARAM("Workbook"));
BOOL bExcel97Stream = ( aStorage->IsStream( aStreamName ) );

aStreamName = String(RTL_CONSTASCII_STRINGPARAM("Book"));
BOOL bExcel5Stream = ( aStorage->IsStream( aStreamName ) );
[[File:deepdetect.jpg]]
*Load a chart in spreadsheet filter
Chart is managed by the class of XclImpObjectManager in spreadsheet. The real implement is XclImpChartObj that is base on XclImplDrawObjBase.
XclImpChart will import the parts of chart, for example, diagram, series, title, background, etc.
[[File:Loadchart.JPG]]

Calc/Implementation/Filter in spreadsheet

2012-06-01T02:11:44Z

Zhaoshzh: (checkpoint save)

== The whole view of filter ==
An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must turn the latter into the former as shown by this diagram.
[[File:Filter_structure.JPG]]
== Filter in symphony ==
When open a file in symphony, the supported filters will be initialized by the class of SfxFilterContainer in sfx2\inc\sfx2.
It contains a member of SfxFilterContainer_Impl *pImpl. Symphony uses this class to control every SfxFilter.
[[File:SfxFilterContainer.JPG.JPG]]
There are a global variable for storing SfxFilter, the name is
static SfxFilterList_Impl* pFilterArr = 0;
it is defined in sfx2\source\bastyp\fltfnc.cxx.
Indeed SfxFilterList_Impl is a list defined by DECLARE_LIST( SfxFilterList_Impl, SfxFilter* ) in sfx2\inc\arrdecl.hxx.
The detail can be traced by the call stack.
[[File:Callstack.JPG]]
== Get the correct filter to load a document ==
To import a real document, symphony should get the file type to use the correct filter.
To get the filter, Symphony will use flat detection and deep detection.
In few words the "flat detection" is a type detection based on document extension, for example,a document named "test.xls", it will get calc to load it by the extension of "xls".
The "deep detection" is the detection that analyzes the document contents. For example, if a document named "test.xls",but it is presentation document, then the deep detection should be joined.
In the file of filter\source\config\cache\typedetection.cxx, the function of
TypeDetection::queryTypeByDescriptor is the entry for getting the filter to loading the document.
*Flat detection
FilterCache::detectFlatForURL, it can get the correct filter by the extention of the document name.
The function is defined in filter\source\config\cache\filtercache.cxx
A subset of document types is defined for a real filter. For example, to calc, it is defined in Basis\share\registry\modules\org\openoffice\TypeDetection\Filter\fcfg_calc_filters.xcu, here is an item for MS excel 97 file format.
<node oor:name="MS Excel 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN PREFERRED</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"/>
<prop oor:name="UserData"/>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Excel 97/2000/XP</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>calc_MS_Excel_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.sheet.SpreadsheetDocument</value></prop>
</node>
The UIName defines the string of MS excel 97 displayed for open/save dialog.
The Type defines the string used in the internal code of Symphony.
The DocumentService defines which service is used to import/export such document.
[[File:Callstack2.JPG]]
*Deep detection
Symphony uses the interface XExtendedFilterDetection to look into the document stream to detect the format. It belongs to :: com :: sun :: star :: document.
This function is called by TypeDetection::impl_askDetectService
in the file filter\source\config\cache\typedetection.cxx
sDeepType = xDetector->detect(lDescriptor);
In the step 3.1, Symphony has got the filters by the file's extention.
The types matching to the given extention.
Calc_MS_Excel_40
Calc_MS_Excel_95
Calc_MS_Excel_97
Calc_Text_txt_csv_StarCalc
Calc_MS_Excel_5095
By the types, Symphony will do the deep detection. It is realized by a spreadsheet servcie of
com.sun.star.comp.calc.FormatDetector.

In the function of TypeDetection::impl_askDetectService(), It
calls xDetector->detect(lDescriptor);
The real implement function is ScFilterDetect::detect()
It is defined in sc\source\ui\unoobj\scdetect.cxx
At first, make a SotStorage by the input stream of MS excel
SotStorageRef aStorage = new SotStorage ( pStream, FALSE );
Then check the content of the file, if there is a sub stream named "Workbook" or "Book".
String aStreamName(RTL_CONSTASCII_STRINGPARAM("Workbook"));
BOOL bExcel97Stream = ( aStorage->IsStream( aStreamName ) );

aStreamName = String(RTL_CONSTASCII_STRINGPARAM("Book"));
BOOL bExcel5Stream = ( aStorage->IsStream( aStreamName ) );
[[File:deepdetect.jpg]]
*Load a chart in spreadsheet filter
Chart is managed by the class of XclImpObjectManager in spreadsheet. The real implement is XclImpChartObj that is base on XclImplDrawObjBase.
XclImpChart will import the parts of chart, for example, diagram, series, title, background, etc.
[[File:Loadchart.JPG]]

File:Loadchart.JPG

2012-06-01T02:10:59Z

Zhaoshzh:

File:Deepdetect.jpg

2012-06-01T02:05:48Z

Zhaoshzh:

File:Callstack2.JPG

2012-06-01T02:03:11Z

Zhaoshzh:

File:Callstack.JPG

2012-06-01T02:02:07Z

Zhaoshzh:

File:SfxFilterContainer.JPG

2012-06-01T02:00:59Z

Zhaoshzh:

File:Filter structure.JPG

2012-06-01T01:59:08Z

Zhaoshzh:

Calc/Implementation/Filter in spreadsheet

2012-06-01T01:56:30Z

Zhaoshzh: Created page with "== The whole view of filter == An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must…"

== The whole view of filter ==
An in-memory Symphony document is represented by it's document model. On disk, the same document is represented as a file. An import component must turn the latter into the former as shown by this diagram.
[[File:Example.jpg]]
== Filter in symphony ==
When open a file in symphony, the supported filters will be initialized by the class of SfxFilterContainer in sfx2\inc\sfx2.
It contains a member of SfxFilterContainer_Impl *pImpl. Symphony uses this class to control every SfxFilter.
There are a global variable for storing SfxFilter, the name is
static SfxFilterList_Impl* pFilterArr = 0;
it is defined in sfx2\source\bastyp\fltfnc.cxx.
Indeed SfxFilterList_Impl is a list defined by DECLARE_LIST( SfxFilterList_Impl, SfxFilter* ) in sfx2\inc\arrdecl.hxx.
The detail can be traced by the call stack.
== Get the correct filter to load a document ==
To import a real document, symphony should get the file type to use the correct filter.
To get the filter, Symphony will use flat detection and deep detection.
In few words the "flat detection" is a type detection based on document extension, for example,a document named "test.xls", it will get calc to load it by the extension of "xls".
The "deep detection" is the detection that analyzes the document contents. For example, if a document named "test.xls",but it is presentation document, then the deep detection should be joined.
In the file of filter\source\config\cache\typedetection.cxx, the function of
TypeDetection::queryTypeByDescriptor is the entry for getting the filter to loading the document.
*Flat detection
FilterCache::detectFlatForURL, it can get the correct filter by the extention of the document name.
The function is defined in filter\source\config\cache\filtercache.cxx
A subset of document types is defined for a real filter. For example, to calc, it is defined in Basis\share\registry\modules\org\openoffice\TypeDetection\Filter\fcfg_calc_filters.xcu, here is an item for MS excel 97 file format.
<node oor:name="MS Excel 97" oor:op="replace">
<prop oor:name="Flags"><value>IMPORT EXPORT ALIEN PREFERRED</value></prop>
<prop oor:name="UIComponent"/>
<prop oor:name="FilterService"/>
<prop oor:name="UserData"/>
<prop oor:name="UIName">
<value xml:lang="x-default">Microsoft Excel 97/2000/XP</value>
</prop>
<prop oor:name="FileFormatVersion"><value>0</value></prop>
<prop oor:name="Type"><value>calc_MS_Excel_97</value></prop>
<prop oor:name="TemplateName"/>
<prop oor:name="DocumentService"><value>com.sun.star.sheet.SpreadsheetDocument</value></prop>
</node>
The UIName defines the string of MS excel 97 displayed for open/save dialog.
The Type defines the string used in the internal code of Symphony.
The DocumentService defines which service is used to import/export such document.
*Deep detection
Symphony uses the interface XExtendedFilterDetection to look into the document stream to detect the format. It belongs to :: com :: sun :: star :: document.
This function is called by TypeDetection::impl_askDetectService
in the file filter\source\config\cache\typedetection.cxx
sDeepType = xDetector->detect(lDescriptor);
In the step 3.1, Symphony has got the filters by the file's extention.
The types matching to the given extention.
Calc_MS_Excel_40
Calc_MS_Excel_95
Calc_MS_Excel_97
Calc_Text_txt_csv_StarCalc
Calc_MS_Excel_5095
By the types, Symphony will do the deep detection. It is realized by a spreadsheet servcie of
com.sun.star.comp.calc.FormatDetector.

In the function of TypeDetection::impl_askDetectService(), It
calls xDetector->detect(lDescriptor);
The real implement function is ScFilterDetect::detect()
It is defined in sc\source\ui\unoobj\scdetect.cxx
At first, make a SotStorage by the input stream of MS excel
SotStorageRef aStorage = new SotStorage ( pStream, FALSE );
Then check the content of the file, if there is a sub stream named "Workbook" or "Book".
String aStreamName(RTL_CONSTASCII_STRINGPARAM("Workbook"));
BOOL bExcel97Stream = ( aStorage->IsStream( aStreamName ) );

aStreamName = String(RTL_CONSTASCII_STRINGPARAM("Book"));
BOOL bExcel5Stream = ( aStorage->IsStream( aStreamName ) );

*Load a chart in spreadsheet filter
Chart is managed by the class of XclImpObjectManager in spreadsheet. The real implement is XclImpChartObj that is base on XclImplDrawObjBase.
XclImpChart will import the parts of chart, for example, diagram, series, title, background, etc.

File:Window clipboard.png

2012-04-27T08:29:52Z

Zhaoshzh: uploaded a new version of "File:Window clipboard.png"

Window_clipboard