Package org.apache.poi.xssf.model
Class ExternalLinksTable
- java.lang.Object
-
- org.apache.poi.ooxml.POIXMLDocumentPart
-
- org.apache.poi.xssf.model.ExternalLinksTable
-
public class ExternalLinksTable extends POIXMLDocumentPart
Holds details of links to parts of other workbooks (eg named ranges), along with the most recently seen values for what they point to.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classExternalLinksTable.ExternalName-
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
-
-
Constructor Summary
Constructors Constructor Description ExternalLinksTable()ExternalLinksTable(PackagePart part)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidcacheData(String sheetName, long rowR, String cellR, String v)protected voidcommit()Save the content in the underlying package part.org.openxmlformats.schemas.spreadsheetml.x2006.main.CTExternalLinkgetCTExternalLink()Deprecated.will be removed because we don't want to expose this (future implementations may not be XMLBeans based)List<Name>getDefinedNames()StringgetLinkedFileName()Returns the last recorded name of the file that this is linked toList<String>getSheetNames()voidreadFrom(InputStream is)voidsetLinkedFileName(String target)Updates the last recorded name for the file that this links tovoidwriteTo(OutputStream out)-
Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toString
-
-
-
-
Constructor Detail
-
ExternalLinksTable
public ExternalLinksTable()
-
ExternalLinksTable
public ExternalLinksTable(PackagePart part) throws IOException
- Throws:
IOException- Since:
- POI 3.14-Beta1
-
-
Method Detail
-
readFrom
public void readFrom(InputStream is) throws IOException
- Throws:
IOException
-
writeTo
public void writeTo(OutputStream out) throws IOException
- Throws:
IOException
-
commit
protected void commit() throws IOExceptionDescription copied from class:POIXMLDocumentPartSave the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified.Sub-classes should override and add logic to marshal the "model" into Ooxml4J.
For example, the code saving a generic XML entry may look as follows:
protected void commit() throws IOException { PackagePart part = getPackagePart(); try (OutputStream out = part.getOutputStream()) { XmlObject bean = getXmlBean(); //the "model" which holds changes in memory bean.save(out, DEFAULT_XML_OPTIONS); } }- Overrides:
commitin classPOIXMLDocumentPart- Throws:
IOException- a subclass may throw an IOException if the changes can't be committed
-
getCTExternalLink
@Internal @Removal(version="6.0.0") public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTExternalLink getCTExternalLink()
Deprecated.will be removed because we don't want to expose this (future implementations may not be XMLBeans based)Returns the underlying xmlbeans object for the external link table. Internal use only. Not currently used internally.
-
getLinkedFileName
public String getLinkedFileName()
Returns the last recorded name of the file that this is linked to
-
setLinkedFileName
public void setLinkedFileName(String target)
Updates the last recorded name for the file that this links to
-
-