Package org.docx4j.openpackaging.parts.SpreadsheetML

Class WorksheetPart

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.parts.Part

org.docx4j.openpackaging.parts.JaxbXmlPart<E>

org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware<E>

org.docx4j.openpackaging.parts.SpreadsheetML.JaxbSmlPart<Worksheet>

org.docx4j.openpackaging.parts.SpreadsheetML.WorksheetPart

All Implemented Interfaces:

XPathEnabled<Worksheet>

public class WorksheetPart
extends JaxbSmlPart<Worksheet>

Field Summary

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

binder, log

Fields inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

jaxbElement, jc, MAX_BYTES_Unmarshal_Error

Fields inherited from class org.docx4j.openpackaging.parts.Part

pack

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor	Description
WorksheetPart()
WorksheetPart(PartName partName)

Method Summary

Modifier and Type	Method	Description
WorkbookPart	getWorkbookPart()	Get the WorkbookPart.
static WorksheetPart	getWorksheetPart(Cell cell)	Given a cell, get its WorksheetPart
static WorksheetPart	getWorksheetPart(Row row)	Given a row, get its WorksheetPart
static WorksheetPart	getWorksheetPart(SheetData sheetData)	Given SheetData, get its WorksheetPart
static WorksheetPart	getWorksheetPart(Worksheet worksheet)	Given a worksheet, get its WorksheetPart
void	init()
void	setJaxbElement(Worksheet jaxbElement)	You can't use this override to create/update a binder, since this would set the jaxbElement field to something different to the object being passed in (as a consequence of the process to create a binder).
Worksheet	unmarshal(InputStream is)	Unmarshal XML data from the specified InputStream and return the resulting content tree.
Worksheet	unmarshal(Element el)

Methods inherited from class org.docx4j.openpackaging.parts.SpreadsheetML.JaxbSmlPart

newPartForContentType

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPartXPathAware

createBinderAndJaxbElement, getBinder, getJAXBAssociationsForXPath, getJAXBAssociationsForXPath, getJAXBNodesViaXPath, getJAXBNodesViaXPath

Methods inherited from class org.docx4j.openpackaging.parts.JaxbXmlPart

addMcChoiceNamespace, getConfiguredUnmarshaller, getContents, getJAXBContext, getJaxbElement, getMcChoiceNamespaces, getMceIgnorable, getXML, inputStreamToXSR, isContentEqual, isUnmarshalled, marshal, marshal, marshal, marshal, pipe, pipe, pipe, preprocess, setContents, setJAXBContext, setJaxbElement, setMceIgnorable, transform, transformToDom, variableReplace

Methods inherited from class org.docx4j.openpackaging.parts.Part

getContentLengthAsLoaded, getOwningRelationshipPart, getPackage, getRelationshipType, getSourceRelationship, getSourceRelationships, getVersion, remove, rename, setContentLengthAsLoaded, setOwningRelationshipPart, setPackage, setPartShortcut, setRelationshipType, setSourceRelationship, setVersion

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getPartName, getRelationshipsPart, getRelationshipsPart, getUserData, reset, setContentType, setPartName, setRelationships, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WorksheetPart

public WorksheetPart(PartName partName)
              throws InvalidFormatException

Throws:

InvalidFormatException

WorksheetPart

public WorksheetPart()
              throws InvalidFormatException

Throws:

InvalidFormatException

Method Details

init

public void init()

setJaxbElement

public void setJaxbElement(Worksheet jaxbElement)

Description copied from class: JaxbXmlPartXPathAware

You can't use this override to create/update a binder, since this would set the jaxbElement field to something different to the object being passed in (as a consequence of the process to create a binder). We don't want that, because calling code may then continue to manipulate the field, without effect.. See instead createBinderAndJaxbElement

Overrides:

setJaxbElement in class JaxbXmlPartXPathAware<Worksheet>

unmarshal

public Worksheet unmarshal(InputStream is)
                    throws jakarta.xml.bind.JAXBException

Description copied from class: JaxbXmlPartXPathAware

Unmarshal XML data from the specified InputStream and return the resulting content tree. Validation event location information may be incomplete when using this form of the unmarshal API.

Implements Unmarshal Global Root Element.

Overrides:

unmarshal in class JaxbXmlPartXPathAware<Worksheet>

Parameters:

is - the InputStream to unmarshal XML data from

Returns:

the newly created root object of the java content tree

Throws:

jakarta.xml.bind.JAXBException - If any unexpected errors occur while unmarshalling

unmarshal

public Worksheet unmarshal(Element el)
                    throws jakarta.xml.bind.JAXBException

Overrides:

unmarshal in class JaxbXmlPartXPathAware<Worksheet>

Throws:

jakarta.xml.bind.JAXBException

getWorkbookPart

public WorkbookPart getWorkbookPart()

Get the WorkbookPart.

Returns:

Since:

3.3.3

getWorksheetPart

public static WorksheetPart getWorksheetPart(Cell cell)

Given a cell, get its WorksheetPart

Returns:

Since:

8.0.0

getWorksheetPart

public static WorksheetPart getWorksheetPart(Row row)

Given a row, get its WorksheetPart

Returns:

Since:

8.0.0

getWorksheetPart

public static WorksheetPart getWorksheetPart(SheetData sheetData)

Given SheetData, get its WorksheetPart

Returns:

Since:

8.0.0

getWorksheetPart

public static WorksheetPart getWorksheetPart(Worksheet worksheet)

Given a worksheet, get its WorksheetPart

Returns:

Since:

8.0.0