2009-05-20 04:02:35 -04:00
|
|
|
/* ====================================================================
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
==================================================================== */
|
|
|
|
package org.apache.poi;
|
|
|
|
|
|
|
|
import org.apache.poi.openxml4j.opc.PackageRelationship;
|
|
|
|
import org.apache.poi.openxml4j.opc.PackagePart;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Defines a factory API that enables sub-classes to create instances of <code>POIXMLDocumentPart</code>
|
|
|
|
*
|
|
|
|
* @author Yegor Kozlov
|
|
|
|
*/
|
|
|
|
public abstract class POIXMLFactory {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a POIXMLDocumentPart from existing package part and relation. This method is called
|
2009-08-21 02:08:31 -04:00
|
|
|
* from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document
|
2009-05-20 04:02:35 -04:00
|
|
|
*
|
2010-10-28 09:02:43 -04:00
|
|
|
* @param parent parent part
|
2009-05-20 04:02:35 -04:00
|
|
|
* @param rel the package part relationship
|
|
|
|
* @param part the PackagePart representing the created instance
|
|
|
|
* @return A new instance of a POIXMLDocumentPart.
|
|
|
|
*/
|
2010-10-28 09:02:43 -04:00
|
|
|
public abstract POIXMLDocumentPart createDocumentPart(POIXMLDocumentPart parent, PackageRelationship rel, PackagePart part);
|
2009-05-20 04:02:35 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when adding new parts
|
|
|
|
* to a document, for example, when adding a sheet to a workbook, slide to a presentation, etc.
|
|
|
|
*
|
|
|
|
* @param descriptor describes the object to create
|
|
|
|
* @return A new instance of a POIXMLDocumentPart.
|
|
|
|
*/
|
|
|
|
public abstract POIXMLDocumentPart newDocumentPart(POIXMLRelation descriptor);
|
|
|
|
}
|