org.apache.poi.xssf.model
Interface XSSFChildContainingModel

All Superinterfaces:
XSSFModel, XSSFWritableModel

public interface XSSFChildContainingModel
extends XSSFModel

Common interface for XSSF models, which have (typically binary) children to them. One example is a VmlDrawing (Drawing), which can have raw images associated with it.


Nested Class Summary
static class XSSFChildContainingModel.WritableChild
           
 
Method Summary
 void generateChild(org.openxml4j.opc.PackagePart childPart, java.lang.String childRelId)
          Called for each matching child, so that the appropriate model or usermodel thing can be created for it.
 XSSFChildContainingModel.WritableChild getChildForWriting(int index)
          Called for each child in turn when writing out, which returns a WritableChild for the child in that position.
 java.lang.String[] getChildrenRelationshipTypes()
          Returns the relationship type of any children we expect
 int getNumberOfChildren()
          Returns the number of children contained, which will need to be written out.
 
Methods inherited from interface org.apache.poi.xssf.model.XSSFModel
readFrom
 
Methods inherited from interface org.apache.poi.xssf.model.XSSFWritableModel
writeTo
 

Method Detail

getChildrenRelationshipTypes

java.lang.String[] getChildrenRelationshipTypes()
Returns the relationship type of any children we expect


generateChild

void generateChild(org.openxml4j.opc.PackagePart childPart,
                   java.lang.String childRelId)
Called for each matching child, so that the appropriate model or usermodel thing can be created for it.

Parameters:
childPart - The PackagePart of the child
childRelId - the ID of the relationship the child comes from

getNumberOfChildren

int getNumberOfChildren()
Returns the number of children contained, which will need to be written out.


getChildForWriting

XSSFChildContainingModel.WritableChild getChildForWriting(int index)
Called for each child in turn when writing out, which returns a WritableChild for the child in that position. The WritableChild has enough information to be able to write it out.

Parameters:
index - A zero based index of this child


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.