Wf: transfered by WikiBackup wikiTask at 2020-07-26T12:20:45Z

2020-07-26T12:20:46Z

transfered by WikiBackup wikiTask at 2020-07-26T12:20:45Z

New page

== Introduction ==
The templates on this page are {{Link|target=Template:Wikitask|title=Wikitask}} helper templates to work with Office Documents.
The Java library being used for Microsoft Office Documents is {{Link|target=https://poi.apache.org/|title=Apache POI}}. For the Access to Adobe Portable
Document Files {{Link|target=https://pdfbox.apache.org/|title=Apache PDFBox}} is used.

=== Supported Document Formats ===
{| class='wikitable sortable'
! Logo
! Format
! Documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://img4.wikia.nocookie.net/__cb20110818174528/logopedia/images/thumb/b/bb/Microsoft_Word_2010_Icon.svg/80px-Microsoft_Word_2010_Icon.svg.png'/>
| {{Link|target=Office#Word|title=Word docx}}
| {{Link|target=http://poi.apache.org/document/quick-guide-xwpf.html|title=XWPF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/xwpf|title=xwpf}}
| {{Link|target=WikiTaskTutorial/Word}}
|-
| <img src='http://img3.wikia.nocookie.net/__cb20130608224647/logopedia/images/thumb/4/43/Office_Word_2000.svg/80px-Office_Word_2000.svg.png'/>
| {{Link|target=Office#Word97|title=Word97 doc}}
| {{Link|target=http://poi.apache.org/document/quick-guide.html|title=HWPF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/hwpf|title=hwpf}}
| {{Link|target=WikiTaskTutorial/Word97}}
|-
| <img src='http://img2.wikia.nocookie.net/__cb20120509174748/logopedia/images/thumb/3/38/It%27s_EXCELlent!.png/80px-It%27s_EXCELlent!.png'/>
| {{Link|target=Office#Excel|title=Excel xlsx}}
| {{Link|target=https://poi.apache.org/spreadsheet/quick-guide.html|title=HSSF+XSSF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/xssf|title=xssf}}
| {{Link|target=WikiTaskTutorial/Excel}}
|-
| <img src='http://img3.wikia.nocookie.net/__cb20120507131818/logopedia/images/thumb/1/1c/Excel.gif/80px-Excel.gif'/>
| {{Link|target=Office#Excel97|title=Excel 97 xls}}
| {{Link|target=https://poi.apache.org/spreadsheet/quick-guide.html|title=HSSF+XSSF}} {{Link|target=https://poi.apache.org/spreadsheet/diagram1.html|title=HSSF UML diagram}}
| {{Link|target=http://stackoverflow.com/questions/tagged/hssf|title=hssf}}
| {{Link|target=WikiTaskTutorial/Excel97}}
|-
| <img src='http://img3.wikia.nocookie.net/__cb20120509173954/logopedia/images/thumb/0/04/PowerPoint.png/80px-PowerPoint.png'/>
| {{Link|target=Office#Powerpoint|title=Powerpoint pptx}}
| {{Link|target=http://poi.apache.org/slideshow/xslf-cookbook.html|title=XSLF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/xslf|title=xslf}}
| {{Link|target=WikiTaskTutorial/Powerpoint}}
|-
| <img src='http://img3.wikia.nocookie.net/__cb20130617071432/logopedia/images/thumb/f/ff/Office_PowerPoint_2000.svg/80px-Office_PowerPoint_2000.svg.png'/>
| {{Link|target=Office#Powerpoint97|title=Powerpoint97 ppt}}
| {{Link|target=http://poi.apache.org/slideshow/how-to-shapes.html|title=HSLF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/hslf|title=hslf}}
| {{Link|target=WikiTaskTutorial/Powerpoint97}}
|-
| <img src='http://www.adobe.com/images/pdficon_large.png' width='64px'/>
| Portable Document Format pdf
| {{Link|https://pdfbox.apache.org/|title=PDF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/pdfbox|title=pdfbox}}
| {{Link|target=WikiTaskTutorial/Portable Document Format}}
|-
| <img src='http://www.lenashore.com/wp-content/uploads/2014/01/vc-ard.png' width='64px'/>
| VCard vcf
| {{Link|https://tools.ietf.org/html/rfc6350|title=VCard}}
| {{Link|target=http://stackoverflow.com/questions/tagged/vcard|title=vcard}}
| {{Link|target=WikiTaskTutorial/VCard}}
|}
The above table shows the supported Document Formats and has links to the Apache POI documentation, corressponding Stackoverflow questions and the
WikiTask tutorial example for each document format.

== Templates ==
=== template structure ===
The following templates have a common structure. First the arguments are declared:
==== @args: arguments ====
<source lang='java' id='args'>
@args() {
String title
String logo
org.sidif.wiki.WikiTask wikiTask
}
</source>
The argument/parameter wikiTask holds the information how the template is called. The input can e.g. be fetched from wikiTask.getInput(). It should
contain the URL of a Microsoft Office Document

==== @import: import statements ====
<source lang='java' id='import'>
@import java.net.URL
@import org.apache.poi.xwpf.usermodel.XWPFDocument;
@import org.apache.poi.xwpf.usermodel.XWPFParagraph
</source>
The import statements are specific to the Office document format being used. See [[{{FULLPAGENAME}}#Supported_Microsoft_Office_Document_Formats]].
==== java code and class declaration ====
<source lang='java' id='class'>
@{
class WordDocx {
...

public WordDocx(String url) {
...
}
} // WordDocx
WordDocx docx=new WordDocx(wikiTask.getInput());

}
</source>
In a Java Code section <nowiki>@{...}</nowiki> a class corresponding to the Microsoft Office Document Format is declared.
The constructor takes a url as a parameter. From such a url e.g. http://somedomain/somedocument.doc the Document is fetched.
==== constructor and error handling ====
<source lang='java' id='errorhandling'>
public XWPFDocument doc;
public Throwable error;

public WordDocx(String url) {
try {
InputStream is = new URL(url).openStream();
doc = new XWPFDocument(is);
} catch (Throwable th) {
error=th;
}
}
</source>
The constructor tries to open the document as the corresponding Apache POI document type. E.g. a docx document is openend as XWPFDocument.
If this fails the Exception/Throwable caught will be available in the member variable error.

=== Word ===
{| class='wikitable sortable'
! Logo
! Format
! Apache POI documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://img4.wikia.nocookie.net/__cb20110818174528/logopedia/images/thumb/b/bb/Microsoft_Word_2010_Icon.svg/80px-Microsoft_Word_2010_Icon.svg.png'/>
| Word docx
| {{Link|target=http://poi.apache.org/document/quick-guide-xwpf.html|title=XWPF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/xwpf|title=xwpf}}
| {{Link|target=WikiTaskTutorial/Word}}
|}
<source lang='java' id='word'>
@args() {
String title
String logo
org.sidif.wiki.WikiTask wikiTask
}
@import java.net.URL
@import org.apache.poi.xwpf.usermodel.XWPFDocument;
@import org.apache.poi.xwpf.usermodel.XWPFParagraph;
@{
class WordDocx {
public XWPFDocument doc;
public Throwable error;

public WordDocx(String url) {
try {
InputStream is = new URL(url).openStream();
doc = new XWPFDocument(is);
} catch (Throwable th) {
error=th;
}
}
} // WordDocx
WordDocx docx=new WordDocx(wikiTask.getInput());

}
</source>

=== Word97 ===

{| class='wikitable sortable'
! Logo
! Format
! Apache POI documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://img3.wikia.nocookie.net/__cb20130608224647/logopedia/images/thumb/4/43/Office_Word_2000.svg/80px-Office_Word_2000.svg.png'/>
| Word97 doc
| {{Link|target=http://poi.apache.org/document/quick-guide.html|title=HWPF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/hwpf|title=hwpf}}
| {{Link|target=WikiTaskTutorial/Word97}}
|}
<source lang='java' id='word97'>
@args() {
String title
String logo
org.sidif.wiki.WikiTask wikiTask
}
@import java.net.URL
@import org.apache.poi.hwpf.HWPFDocument;
@import org.apache.poi.hwpf.extractor.WordExtractor;
@import org.apache.poi.hwpf.usermodel.Range;
@import org.apache.poi.poifs.filesystem.POIFSFileSystem;
@{
class WordDoc {
public HWPFDocument doc;
public WordExtractor we;
public Range range;
public Throwable error;

public WordDoc(String url) {
try {
InputStream is = new URL(url).openStream();
POIFSFileSystem fs = new POIFSFileSystem(is);
doc = new HWPFDocument(fs);
we = new WordExtractor(doc);
range = doc.getRange();
} catch (Throwable th) {
error=th;
}
}
} // WordDoc
WordDoc doc=new WordDoc(wikiTask.getInput());

}
</source>

=== Excel ===
{| class='wikitable sortable'
! Logo
! Format
! Apache POI documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://img2.wikia.nocookie.net/__cb20120509174748/logopedia/images/thumb/3/38/It%27s_EXCELlent!.png/80px-It%27s_EXCELlent!.png'/>
| Excel xlsx
| {{Link|target=https://poi.apache.org/spreadsheet/quick-guide.html|title=HSSF+XSSF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/xssf|title=xssf}}
| {{Link|target=WikiTaskTutorial/Excel}}
|}
<source lang='java' id='excel'>
@args() {
String title
String logo
org.sidif.wiki.WikiTask wikiTask
}
@import java.net.URL
@import org.apache.poi.ss.usermodel.Cell
@import org.apache.poi.ss.usermodel.Row
@import org.apache.poi.xssf.usermodel.XSSFSheet
@import org.apache.poi.xssf.usermodel.XSSFWorkbook
@import org.apache.poi.xssf.usermodel.XSSFCell
@import org.apache.poi.xssf.usermodel.XSSFRow
@{
class Excel {
public XSSFWorkbook workbook =null;
public Throwable error;

public List<List<String>> getSheetContent(XSSFSheet sheet) {
List<List<String>> result=new ArrayList<List<String>>();
Iterator<Row> rows = sheet.rowIterator();
while (rows.hasNext()) {
XSSFRow row = (XSSFRow) rows.next();
Iterator<Cell> cells = row.cellIterator();
List<String> rowList=new ArrayList<String>();
while (cells.hasNext()) {
XSSFCell cell = (XSSFCell) cells.next();
String cellValue = cell.toString();
if (!"".equals(cellValue))
rowList.add(cellValue);
}
if (rowList.size()>0)
result.add(rowList);
}
return result;
}

public Excel(String url) {
// http://stackoverflow.com/questions/5836965/how-to-open-xlsx-files-with-poi-ss
try {
InputStream is = new URL(url).openStream();
workbook = new XSSFWorkbook(is);
} catch (Throwable th) {
error=th;
}
}
} // Excel
Excel excel=new Excel(wikiTask.getInput());

}
</source>

=== Excel97 ===
{| class='wikitable sortable'
! Logo
! Format
! Apache POI documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://img3.wikia.nocookie.net/__cb20120507131818/logopedia/images/thumb/1/1c/Excel.gif/80px-Excel.gif'/>
| Excel97 xls
| {{Link|target=https://poi.apache.org/spreadsheet/quick-guide.html|title=HSSF+XSSF}} {{Link|target=https://poi.apache.org/spreadsheet/diagram1.html|title=HSSF UML diagram}}
| {{Link|target=http://stackoverflow.com/questions/tagged/hssf|title=hssf}}
| {{Link|target=WikiTaskTutorial/Excel97}}
|}
<source lang='java' id='excel97'>
@args() {
String title
String logo
org.sidif.wiki.WikiTask wikiTask
}
@import java.net.URL
@import org.apache.poi.ss.usermodel.Row
@import org.apache.poi.ss.usermodel.Cell
@import org.apache.poi.hssf.usermodel.HSSFSheet;
@import org.apache.poi.hssf.usermodel.HSSFWorkbook;
@import org.apache.poi.hssf.usermodel.HSSFCell;
@import org.apache.poi.hssf.usermodel.HSSFRow;
@{
class Excel {
public HSSFWorkbook workbook =null;
public Throwable error;

public List<List<String>> getSheetContent(HSSFSheet sheet) {
List<List<String>> result=new ArrayList<List<String>>();
Iterator<Row> rows = sheet.rowIterator();
while (rows.hasNext()) {
HSSFRow row = (HSSFRow) rows.next();
Iterator<Cell> cells = row.cellIterator();
List<String> rowList=new ArrayList<String>();
int nonempty=0;
while (cells.hasNext()) {
HSSFCell cell = (HSSFCell) cells.next();
String cellValue = cell.toString();
if (!"".equals(cellValue)) {
nonempty++;
rowList.add(cellValue);
} else {
rowList.add("");
}
}
if (nonempty>0)
result.add(rowList);
}
return result;
}

public Excel(String url) {
// http://stackoverflow.com/questions/5836965/how-to-open-xlsx-files-with-poi-ss
try {
InputStream is = new URL(url).openStream();
workbook = new HSSFWorkbook(is);
} catch (Throwable th) {
error=th;
}
}
} // Excel
Excel excel=new Excel(wikiTask.getInput());

}
</source>

=== Powerpoint ===
{| class='wikitable sortable'
! Logo
! Format
! Apache POI documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://img3.wikia.nocookie.net/__cb20120509173954/logopedia/images/thumb/0/04/PowerPoint.png/80px-PowerPoint.png'/>
| Powerpoint pptx
| {{Link|target=http://poi.apache.org/slideshow/xslf-cookbook.html|title=XSLF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/xslf|title=xslf}}
| {{Link|target=WikiTaskTutorial/Powerpoint}}
|}

<source lang='java' id='powerpoint'>
@args() {
String title
String logo
org.sidif.wiki.WikiTask wikiTask
}
@import java.net.URL
@import org.apache.poi.ss.usermodel.Cell
@import org.apache.poi.xslf.usermodel.XMLSlideShow;
@import org.apache.poi.xslf.usermodel.XSLFCommentAuthors
@import org.apache.poi.xslf.usermodel.XSLFComments
@import org.apache.poi.xslf.usermodel.XSLFCommonSlideData
@import org.apache.poi.xslf.usermodel.XSLFNotes
@import org.apache.poi.xslf.usermodel.XSLFRelation
@import org.apache.poi.xslf.usermodel.XSLFSlide
@import org.apache.poi.xslf.usermodel.XSLFSlideLayout
@import org.apache.poi.xslf.usermodel.XSLFSlideMaster
@{
class Powerpoint {
public XMLSlideShow slideshow=null;
public List<XSLFSlide> slides=null;
public Throwable error;

public Powerpoint(String url) {
try {
InputStream is = new URL(url).openStream();
slideshow = new XMLSlideShow(is);
slides = slideshow.getSlides();
} catch (Throwable th) {
error=th;
}
}
} // Powerpoint
Powerpoint powerpoint=new Powerpoint(wikiTask.getInput());
}
</source>

=== Powerpoint97 ===
{| class='wikitable sortable'
! Logo
! Format
! Apache POI documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://img3.wikia.nocookie.net/__cb20130617071432/logopedia/images/thumb/f/ff/Office_PowerPoint_2000.svg/80px-Office_PowerPoint_2000.svg.png'/>
| Powerpoint97 ppt
| {{Link|target=http://poi.apache.org/slideshow/how-to-shapes.html|title=HSLF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/hslf|title=hslf}}
| {{Link|target=WikiTaskTutorial/Powerpoint97}}
|}
<source lang='java' id='powerpoint97'>
@args() {
String title
String logo
org.sidif.wiki.WikiTask wikiTask
}
@import java.net.URL
@import org.apache.poi.hslf.usermodel.SlideShow
@import org.apache.poi.hslf.model.Slide
@{
class Powerpoint {
public SlideShow slideshow=null;
public Slide[] slides=null;
public Throwable error;

public Powerpoint(String url) {
try {
InputStream is = new URL(url).openStream();
slideshow = new SlideShow(is);
is.close();
slides = slideshow.getSlides();
} catch (Throwable th) {
error=th;
}
}
} // Powerpoint
Powerpoint powerpoint=new Powerpoint(wikiTask.getInput());
}
</source>
=== PDF ===
{| class='wikitable sortable'
! Logo
! Format
! Apache documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://www.adobe.com/images/pdficon_large.png' width='64px'/>
| Portable Document Format pdf
| {{Link|https://pdfbox.apache.org/|title=PDF}}
| {{Link|target=http://stackoverflow.com/questions/tagged/pdfbox|title=pdfbox}}
| {{Link|target=WikiTaskTutorial/Portable Document Format}}
|}
<source lang='java' id='pdf'>
@args() {
String title
String logo
org.sidif.wiki.WikiTask wikiTask
}
@import java.net.URL
@import org.apache.pdfbox.pdmodel.PDDocument
@import org.apache.pdfbox.pdmodel.PDPage
@import org.apache.pdfbox.util.PDFTextStripper
@{
/**
* Portable Document File extractor help
*/
class PDF {
public Throwable error;
PDDocument doc;
PDFTextStripper pdfStripper;

/**
* construct this PDF from the given url
*/
public PDF(String url) {
try {
// might want to switch off logging here to improve performance
String[] loggers = { "org.apache.pdfbox.util.PDFStreamEngine",
"org.apache.pdfbox.util", "org.apache.pdfbox.util.PDFStreamEngine",
"org.apache.pdfbox.pdfparser.PDFObjectStreamParser",
"org.apache.pdfbox.cos.COSDocument",
"org.apache.pdfbox.pdmodel.font.PDSimpleFont",
"org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap",
"org.apache.pdfbox.pdmodel.graphics.color.PDSeparation",
"org.apache.pdfbox.pdmodel.graphics.color.PDColorState",
"org.apache.pdfbox.pdmodel.graphics.color.PDICCBased",
"org.apache.pdfbox.pdfparser.PDFObjectStreamParser" };
for (String logger : loggers) {
org.apache.log4j.Logger logpdfengine = org.apache.log4j.Logger
.getLogger(logger);
logpdfengine.setLevel(org.apache.log4j.Level.OFF);
}
InputStream is = new URL(url).openStream();
doc=PDDocument.load(is);
pdfStripper = new PDFTextStripper();
} catch(Throwable th) {
error=th;
}
}
public String getPageText(int page) {
String result="?";
try {
pdfStripper.setStartPage(page);
pdfStripper.setEndPage(page);
result=pdfStripper.getText(doc);
} catch(Throwable th) {
error=th;
result="Error: "+th.getMessage();
}
return result;
}
}
// don't create this here ... but might make tutorial examples fail
// PDF pdf=new PDF(wikiTask.getInput());
}
</source>

=== VCard ===
{| class='wikitable sortable'
! Logo
! Format
! Documentation
! Stackoverflow
! Tutorial example
|-
| <img src='http://www.lenashore.com/wp-content/uploads/2014/01/vc-ard.png' width='64px'/>
| VCard vcf
| {{Link|https://tools.ietf.org/html/rfc6350|title=VCard}}
| {{Link|target=http://stackoverflow.com/questions/tagged/vcard|title=vcard}}
| {{Link|target=WikiTaskTutorial/VCard}}
|}
<source lang='java' id='vcard'>
@args() {
org.sidif.wiki.WikiTask wikiTask
}
@import java.net.URL
@import ezvcard.Ezvcard
@import ezvcard.VCard
@import ezvcard.property.Email
@import ezvcard.property.Address
@import ezvcard.property.Title
@import ezvcard.property.Telephone
@import ezvcard.property.Note
@{
/**
* holder for a VCard
*/
class VCardHolder {
String text;
Throwable error;
VCard vcard;

/**
* construct a VCard from the given url
*/
public VCardHolder(String url) {
try {
InputStream is = new URL(url).openStream();
text=org.apache.commons.io.IOUtils.toString(is, "UTF-8");
vcard = Ezvcard.parse(text).first();
} catch (Throwable th) {
error=th;
}
}
}
VCardHolder vcardHolder=new VCardHolder(wikiTask.getInput());

}
@def vcardAddressAsTableRow(Address address) {
!@(address.getTypes().toArray()[0]) address
|@address.getStreetAddress()<br>@address.getPostalCode() @address.getLocality()<br>@address.getCountry()
|-
}
@def vcardPhoneAsTableRow(Telephone phone) {
!@if (phone.getTypes().size()>0) { @phone.getTypes().toArray()[0] } phone
|<nowiki>@phone.getText()</nowiki>
|-
}
@def vcardNoteAsTableRow(Note note) {
!note
|<nowiki>@note.getValue()</nowiki>
|-
}
@def vcardTitleAsTableRow(Title title) {
! @if (title.getType()) { @title.getType() } title
|@title.getValue()
|-
}
@def vcardAsTable(VCard vcard) {
@("{|") class='wikitable sortable'
!fullname:
|@vcard.getFormattedName().getValue()
|-
@for (Title title:vcard.getTitles()) {
@vcardTitleAsTableRow(title);
}
!firstname:
|@vcard.getStructuredName().getGiven()
|-
!lastname:
|@vcard.getStructuredName().getFamily()
|-
!organization:
|@if (vcard.getOrganization()) { @vcard.getOrganization().getValues().get(0) }
|-
@for (Address address:vcard.getAddresses()) {
@vcardAddressAsTableRow(address)
}
@for (Email email : vcard.getEmails()){
!email:
|@email.getValue()
|-
}
@for (Telephone phone : vcard.getTelephoneNumbers()) {
@vcardPhoneAsTableRow(phone)
}
@for (Note note : vcard.getNotes()) {
@vcardNoteAsTableRow(note)
}
@("|}")
}
</source>

Office - Revision history

Wf: transfered by WikiBackup wikiTask at 2020-07-26T12:20:45Z