909 lines
No EOL
88 KiB
XML
909 lines
No EOL
88 KiB
XML
<xqdoc:xqdoc xmlns:xqdoc="http://www.xqdoc.org/1.0"><xqdoc:control><xqdoc:date>2025-06-03T22:34:04.782+01:00</xqdoc:date><xqdoc:version>1.1</xqdoc:version></xqdoc:control><xqdoc:module type="library"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>pdfbox</xqdoc:name><xqdoc:comment><xqdoc:description>
|
||

|
||
A BaseX 10.7+ interface to pdfbox3 https://pdfbox.apache.org/ ,
|
||
requires pdfbox jars on classpath, in lib/custom or xar
|
||
refer to the same concept. Also label and (page)range are used interchangably
|
||
</xqdoc:description><xqdoc:author>Andy Bunce 2025</xqdoc:author><xqdoc:see>https://pdfbox.apache.org/download.cgi</xqdoc:see><xqdoc:custom tag="note">following the java source the terms outline and bookmark</xqdoc:custom><xqdoc:custom tag="note">tested with pdfbox-app-3.0.5.jar</xqdoc:custom><xqdoc:custom tag="javadoc">https://javadoc.io/static/org.apache.pdfbox/pdfbox/3.0.5/</xqdoc:custom></xqdoc:comment><xqdoc:body>xquery version '3.1';
|
||
(:~ 
|
||
A BaseX 10.7+ interface to pdfbox3 https://pdfbox.apache.org/ , 
|
||
requires pdfbox jars on classpath, in lib/custom or xar
|
||
@note following the java source the terms outline and bookmark
|
||
refer to the same concept. Also label and (page)range are used interchangably
|
||
@note tested with pdfbox-app-3.0.5.jar
|
||
@see https://pdfbox.apache.org/download.cgi
|
||
@javadoc https://javadoc.io/static/org.apache.pdfbox/pdfbox/3.0.5/
|
||
@author Andy Bunce 2025
|
||
:)
|
||

|
||
module namespace pdfbox="org.expkg_zone58.Pdfbox3";
|
||

|
||
declare namespace Loader ="java:org.apache.pdfbox.Loader"; 
|
||
declare namespace PDFTextStripper = "java:org.apache.pdfbox.text.PDFTextStripper";
|
||
declare namespace PDDocument ="java:org.apache.pdfbox.pdmodel.PDDocument";
|
||
declare namespace PDDocumentCatalog ="java:org.apache.pdfbox.pdmodel.PDDocumentCatalog";
|
||
declare namespace PDPageLabels ="java:org.apache.pdfbox.pdmodel.common.PDPageLabels";
|
||
declare namespace PDPageLabelRange="java:org.apache.pdfbox.pdmodel.common.PDPageLabelRange";
|
||

|
||
declare namespace PageExtractor ="java:org.apache.pdfbox.multipdf.PageExtractor";
|
||
declare namespace PDPage ="java:org.apache.pdfbox.pdmodel.PDPage";
|
||
declare namespace PDPageTree ="java:org.apache.pdfbox.pdmodel.PDPageTree";
|
||
declare namespace PDDocumentOutline ="java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline";
|
||
declare namespace PDDocumentInformation ="java:org.apache.pdfbox.pdmodel.PDDocumentInformation";
|
||
declare namespace PDOutlineItem="java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem";
|
||
declare namespace PDFRenderer="java:org.apache.pdfbox.rendering.PDFRenderer";
|
||
declare namespace PDMetadata="java:org.apache.pdfbox.pdmodel.common.PDMetadata";
|
||
declare namespace COSInputStream="java:org.apache.pdfbox.cos.COSInputStream";
|
||

|
||

|
||
declare namespace rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#";
|
||

|
||

|
||
declare namespace RandomAccessReadBuffer="java:org.apache.pdfbox.io.RandomAccessReadBuffer";
|
||
declare namespace RandomAccessReadBufferedFile = "java:org.apache.pdfbox.io.RandomAccessReadBufferedFile";
|
||
declare namespace PDRectangle="org.apache.pdfbox.pdmodel.common.PDRectangle";
|
||

|
||
declare namespace File ="java:java.io.File";
|
||

|
||

|
||

|
||
(:~ "With-document" pattern: open pdf,apply $fn function, close pdf
|
||
creates a local pdfobject and ensures it is closed after use
|
||
e.g pdfbox:with-pdf("path...",pdfbox:page-text(?,5))
|
||
:)
|
||
declare function pdfbox:with-pdf($src as xs:string,
|
||
$fn as function(item())as item()*)
|
||
as item()*{
|
||
let $pdf:=pdfbox:open($src)
|
||
return try{
|
||
$fn($pdf),pdfbox:close($pdf)
|
||
} catch *{
|
||
pdfbox:close($pdf),fn:error($err:code,$src || " " || $err:description)
|
||
}
|
||

|
||
};
|
||

|
||

|
||
(:~ open pdf using fetch:binary, returns pdf object :)
|
||
declare function pdfbox:open($pdfsrc as item())
|
||
as item(){
|
||
pdfbox:open($pdfsrc, map{})
|
||
};
|
||

|
||
(:~ open pdf from file/url/binary, opts may have password , returns pdf object 
|
||
@param $pdfsrc a fetchable url or filepath, or xs:base64Binary item
|
||
@param $opts options options include map {"password":}
|
||
@note fetch:binary for https will use a lot of memory here
|
||
:)
|
||
declare function pdfbox:open($pdfsrc as item(), $opts as map(*))
|
||
as item(){
|
||
try{
|
||

|
||
if($pdfsrc instance of xs:base64Binary)
|
||
then Loader:loadPDF( $pdfsrc,string($opts?password))
|
||
else if(starts-with($pdfsrc,"http"))
|
||
then Loader:loadPDF( fetch:binary($pdfsrc),string($opts?password))
|
||
else Loader:loadPDF(RandomAccessReadBufferedFile:new($pdfsrc),string($opts?password))
|
||

|
||
} catch *{
|
||
let $loc:=if($pdfsrc instance of xs:base64Binary)
|
||
then "xs:base64Binary"
|
||
else $pdfsrc
|
||
return error(xs:QName("pdfbox:open"),"Failed PDF load " || $loc || " " || $err:description)
|
||
}
|
||
};
|
||

|
||
(:~ The version of the PDF specification used by $pdf e.g "1.4"
|
||
returned as string to avoid float rounding issues
|
||
:)
|
||
declare function pdfbox:specification($pdf as item())
|
||
as xs:string{
|
||
PDDocument:getVersion($pdf)=>xs:decimal()=>round(4)=>string()
|
||
};
|
||

|
||
(:~ Save pdf $pdf to filesystem at $savepath , returns $savepath :)
|
||
declare function pdfbox:pdf-save($pdf as item(),$savepath as xs:string)
|
||
as xs:string{
|
||
PDDocument:save($pdf, File:new($savepath)),$savepath
|
||
};
|
||

|
||
(:~ Create binary representation of $pdf object as xs:base64Binary :)
|
||
declare function pdfbox:binary($pdf as item())
|
||
as xs:base64Binary{
|
||
let $bytes:=Q{java:java.io.ByteArrayOutputStream}new()
|
||
let $_:=PDDocument:save($pdf, $bytes)
|
||
return Q{java:java.io.ByteArrayOutputStream}toByteArray($bytes)
|
||
=>convert:integers-to-base64()
|
||
};
|
||

|
||
(:~ Release any resources related to $pdf:)
|
||
declare function pdfbox:close($pdf as item())
|
||
as empty-sequence(){
|
||
(# db:wrapjava void #) {
|
||
PDDocument:close($pdf)
|
||
}
|
||
};
|
||

|
||
(:~ Number of pages in PDF:)
|
||
declare function pdfbox:number-of-pages($pdf as item())
|
||
as xs:integer{
|
||
PDDocument:getNumberOfPages($pdf)
|
||
};
|
||

|
||
(:~ Pdf page as image (zero is cover)
|
||
options.format="bmp jpg png gif" etc, options.scale= 1 is 72 dpi?? :)
|
||
declare function pdfbox:page-render($pdf as item(),$pageNo as xs:integer,$options as map(*))
|
||
as xs:base64Binary{
|
||
let $options := map:merge(($options,map{"format":"jpg","scale":1}))
|
||
let $bufferedImage := PDFRenderer:new($pdf)
|
||
=>PDFRenderer:renderImage($pageNo,$options?scale)
|
||
let $bytes := Q{java:java.io.ByteArrayOutputStream}new()
|
||
let $_ := Q{java:javax.imageio.ImageIO}write($bufferedImage ,$options?format, $bytes)
|
||
return Q{java:java.io.ByteArrayOutputStream}toByteArray($bytes)
|
||
=>convert:integers-to-base64()
|
||

|
||
};
|
||

|
||

|
||
(:~ property access map
|
||
keys are property names, 
|
||
values are sequences of functions to get property from $pdf object
|
||
:)
|
||
declare %private variable $pdfbox:property-map:=map{
|
||
"#pages": pdfbox:number-of-pages#1,
|
||

|
||
"#bookmarks": pdfbox:number-of-bookmarks#1,
|
||

|
||
"#labels": pdfbox:number-of-labels#1,
|
||

|
||
"specification":pdfbox:specification#1,
|
||

|
||
"title": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getTitle#1) ,
|
||

|
||
"author": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getAuthor#1 ),
|
||

|
||
"creator": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getCreator#1),
|
||

|
||
"producer": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getProducer#1),
|
||

|
||
"subject": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getSubject#1),
|
||

|
||
"keywords": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getKeywords#1),
|
||

|
||
"creationDate": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getCreationDate#1,
|
||
pdfbox:gregToISO#1),
|
||

|
||
"modificationDate": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getModificationDate#1,
|
||
pdfbox:gregToISO#1),
|
||
"labels": pdfbox:labels-as-strings#1 
|
||
};
|
||

|
||
(:~ known property names sorted :)
|
||
declare function pdfbox:property-names() 
|
||
as xs:string*{
|
||
$pdfbox:property-map=>map:keys()=>sort()
|
||
};
|
||

|
||
(:~ return value of $property for $pdf :)
|
||
declare function pdfbox:property($pdf as item(),$property as xs:string)
|
||
as item()*{
|
||
let $fns:= $pdfbox:property-map($property)
|
||
return if(exists($fns))
|
||
then fold-left($fns, 
|
||
$pdf, 
|
||
function($result,$this as function(*)){$result!$this(.)})
|
||
else error(xs:QName('pdfbox:property'),concat("Property '",$property,"' not defined."))
|
||
};
|
||

|
||
(:~ summary CSV style info for all properties for $pdfpaths 
|
||
:)
|
||
declare function pdfbox:report($pdfpaths as xs:string*)
|
||
as map(*){
|
||
pdfbox:report($pdfpaths,pdfbox:property-names())
|
||
};
|
||

|
||
(:~ summary CSV style info for named properties for $pdfpaths 
|
||
@see https://docs.basex.org/main/CSV_Functions#xquery
|
||
:)
|
||
declare function pdfbox:report($pdfpaths as item()*, $properties as xs:string*)
|
||
as map(*){
|
||
map{"names": array{"path",$properties},
|
||

|
||
"records": for $path in $pdfpaths
|
||
let $name:=if($path instance of xs:base64Binary) then "binary" else $path
|
||
return try{
|
||
let $pdf:=pdfbox:open($path)
|
||
return (fold-left($properties,
|
||
array{$name},
|
||
function($result as array(*),$prop as xs:string){
|
||
array:append($result, string(pdfbox:property($pdf, $prop)))}
|
||
), pdfbox:close($pdf)
|
||
)
|
||
} catch *{
|
||
fold-left($properties,
|
||
array{$name},
|
||
function($result as array(*),$prop as xs:string){
|
||
array:append($result, "#ERROR")}
|
||
)
|
||
}
|
||

|
||
}
|
||
};
|
||

|
||
(:~ convenience function to save report() data to file :)
|
||
declare function pdfbox:report-save($data as map(*),$dest as xs:string)
|
||
as empty-sequence(){
|
||
let $opts := map { "format":"xquery", "header":"yes", "separator" : "," }
|
||
return file:write-text($dest,csv:serialize($data,$opts))
|
||
};
|
||

|
||
(:~ number of outline items :)
|
||
declare function pdfbox:number-of-bookmarks($pdf as item())
|
||
as xs:integer{
|
||
let $xml:=pdfbox:outline-xml($pdf)
|
||
return count($xml//bookmark)
|
||
};
|
||

|
||
(:~ XMP metadata as "RDF" document
|
||
@note usually rdf:RDF root, but sometimes x:xmpmeta 
|
||
:)
|
||
declare function pdfbox:metadata($pdf as item())
|
||
as document-node(element(*))?
|
||
{
|
||
let $m:=PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getMetadata()
|
||
return if(exists($m))
|
||
then 
|
||
let $is:=PDMetadata:exportXMPMetadata($m)
|
||
return pdfbox:do-until(
|
||
map{"n":0,"data":""},
|
||

|
||
function($input,$pos ) { pdfbox:read-stream($is,$input?data)},
|
||

|
||
function($output,$pos) { $output?n eq -1 } 
|
||
)?data=>parse-xml()
|
||
else ()
|
||
};
|
||

|
||
(:~ read next block from XMP stream :)
|
||
declare %private function pdfbox:read-stream($is,$read as xs:string)
|
||
as map(*){
|
||
let $blen:=4096
|
||
let $buff:=Q{java:java.util.Arrays}copyOf(array{xs:byte(0)},$blen)
|
||
let $n:= COSInputStream:read($is,$buff,xs:int(0),xs:int($blen))
|
||
let $data:=convert:integers-to-base64(subsequence($buff,1,$n))=>convert:binary-to-string()
|
||
return map{"n":$n, "data": $read || $data}
|
||
};
|
||

|
||
(:~ outline for $pdf as map()* :)
|
||
declare function pdfbox:outline($pdf as item())
|
||
as map(*)*{
|
||
(# db:wrapjava some #) {
|
||
let $outline:=
|
||
PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getDocumentOutline()
|
||

|
||
return if(exists($outline))
|
||
then pdfbox:outline($pdf,PDOutlineItem:getFirstChild($outline)) 
|
||
}
|
||
};
|
||

|
||
(:~ return bookmark info for children of $outlineItem as seq of maps :)
|
||
declare function pdfbox:outline($pdf as item(),$outlineItem as item()?)
|
||
as map(*)*{
|
||
let $find as map(*):=pdfbox:outline_($pdf ,$outlineItem)
|
||
return map:get($find,"list")
|
||
};
|
||

|
||
(:~ BaseX bug 10.7? error if inlined in outline :)
|
||
declare %private function pdfbox:outline_($pdf as item(),$outlineItem as item()?)
|
||
as map(*){
|
||
pdfbox:do-until(
|
||

|
||
map{"list":(),"this":$outlineItem},
|
||

|
||
function($input,$pos ) { 
|
||
let $bk:= pdfbox:bookmark($input?this,$pdf)
|
||
let $bk:= if($bk?hasChildren)
|
||
then let $kids:=pdfbox:outline($pdf,PDOutlineItem:getFirstChild($input?this))
|
||
return map:merge(($bk,map:entry("children",$kids)))
|
||
else $bk 
|
||
return map{
|
||
"list": ($input?list, $bk),
|
||
"this": PDOutlineItem:getNextSibling($input?this)}
|
||
},
|
||

|
||
function($output,$pos) { empty($output?this) } 
|
||
)
|
||
};
|
||

|
||
(:~ PDF outline in xml format :)
|
||
declare function pdfbox:outline-xml($pdf as item())
|
||
as element(outline)?{
|
||
let $outline:=pdfbox:outline($pdf)
|
||
return if(exists($outline))
|
||
then <outline>{$outline!pdfbox:bookmark-xml(.)}</outline>
|
||
else ()
|
||
};
|
||

|
||
(:~ Convert outline map to XML :)
|
||
declare %private function pdfbox:bookmark-xml($outline as map(*)*)
|
||
as element(bookmark)*
|
||
{
|
||
$outline!
|
||
<bookmark title="{?title}" index="{?index}">
|
||
{?children!pdfbox:bookmark-xml(.)}
|
||
</bookmark>
|
||
};
|
||

|
||
(:~ Return bookmark info for $bookmark
|
||
@return map{index:..,title:..,hasChildren:..}
|
||
:)
|
||
declare %private function pdfbox:bookmark($bookmark as item(),$pdf as item())
|
||
as map(*)
|
||
{
|
||
map{ 
|
||
"index": PDOutlineItem:findDestinationPage($bookmark,$pdf)=>pdfbox:find-page($pdf),
|
||
"title": (# db:checkstrings #) {PDOutlineItem:getTitle($bookmark)}
|
||
(:=>translate("<22>",""), :),
|
||
"hasChildren": PDOutlineItem:hasChildren($bookmark)
|
||
}
|
||
};
|
||

|
||

|
||
(:~ pageIndex of $page in $pdf :)
|
||
declare function pdfbox:find-page(
|
||
$page as item()? (: as java:org.apache.pdfbox.pdmodel.PDPage :),
|
||
$pdf as item())
|
||
as item()?
|
||
{
|
||
if(exists($page))
|
||
then PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPages()
|
||
=>PDPageTree:indexOf($page)
|
||
}; 
|
||

|
||
(:~ Return new PDF doc with pages from $start to $end as xs:base64Binary, (1 based) 
|
||
@param $start first page to include
|
||
@param $end last page to include
|
||
:)
|
||
declare function pdfbox:extract-range($pdf as item(), 
|
||
$start as xs:integer,$end as xs:integer)
|
||
as xs:base64Binary
|
||
{
|
||
let $a:=PageExtractor:new($pdf, $start, $end) =>PageExtractor:extract()
|
||
return (pdfbox:binary($a),pdfbox:close($a)) 
|
||
};
|
||

|
||
(:~ The number of labels defined in PDF :)
|
||
declare function pdfbox:number-of-labels($pdf as item())
|
||
as xs:integer
|
||
{
|
||
let $labels:=PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
return if(exists($labels)) 
|
||
then PDPageLabels:getPageRangeCount($labels)
|
||
else 0
|
||
};
|
||

|
||
(:~ pageLabel for every page from derived from page-ranges
|
||
The returned sequence will contain at MOST as much entries as the document has pages.
|
||
@see https://www.w3.org/TR/WCAG20-TECHS/PDF17.html#PDF17-examples
|
||
@see https://codereview.stackexchange.com/questions/286078/java-code-showing-page-labels-from-pdf-files
|
||
:)
|
||
declare function pdfbox:labels-by-page($pdf as item())
|
||
as xs:string*
|
||
{
|
||
PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
=>PDPageLabels:getLabelsByPageIndices()
|
||
};
|
||

|
||
(:~ sequence of label ranges defined in PDF as formatted strings :)
|
||
declare function pdfbox:labels-as-strings($pdf as item())
|
||
as xs:string{
|
||
let $pagelabels:=PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
return $pagelabels
|
||
!(0 to pdfbox:number-of-pages($pdf)-1)
|
||
!pdfbox:label-as-string($pagelabels,.)=>string-join(",")
|
||

|
||
};
|
||

|
||
(:~ get pagelabels exist :)
|
||
declare function pdfbox:page-labels($pdf)
|
||
{
|
||
PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
};
|
||

|
||
(:~ label for $page formated as string :)
|
||
declare function pdfbox:label-as-string($pagelabels,$page as xs:integer)
|
||
as xs:string?{
|
||
let $label:=PDPageLabels:getPageLabelRange($pagelabels,$page)
|
||
return if(empty($label))
|
||
then ()
|
||
else
|
||
let $start:= PDPageLabelRange:getStart($label)
|
||
let $style := PDPageLabelRange:getStyle($label)
|
||
let $prefix:= PDPageLabelRange:getPrefix($label) 
|
||
return string-join(($page, 
|
||
if(empty($style)) then "-" else $style,
|
||
if(($start eq 1)) then "" else $start,
|
||
if(exists($prefix)) then '*' || $prefix (:TODO double " :)
|
||
))
|
||
};
|
||

|
||
(:~ sequence of maps for each label in :)
|
||
declare function pdfbox:labels-as-map($pdf as item())
|
||
as map(*)*{
|
||
let $pagelabels:=PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
return $pagelabels
|
||
!(0 to pdfbox:number-of-pages($pdf)-1)
|
||
!pdfbox:label-as-map($pagelabels,.)
|
||
};
|
||

|
||
(:~ express label/page-range for $page as map :)
|
||
declare function pdfbox:label-as-map($pagelabels,$page as xs:integer)
|
||
as map(*)
|
||
{
|
||
let $label:=PDPageLabels:getPageLabelRange($pagelabels,$page)
|
||
return if(empty($label))
|
||
then ()
|
||
else map{
|
||
"index": $page,
|
||
"prefix": PDPageLabelRange:getPrefix($label),
|
||
"start": PDPageLabelRange:getStart($label),
|
||
"style": PDPageLabelRange:getStyle($label)
|
||
}
|
||
};
|
||

|
||

|
||

|
||
(:~ return text on $pageNo :)
|
||
declare function pdfbox:page-text($pdf as item(), $pageNo as xs:integer)
|
||
as xs:string{
|
||
let $tStripper := (# db:wrapjava instance #) {
|
||
PDFTextStripper:new()
|
||
=> PDFTextStripper:setStartPage($pageNo)
|
||
=> PDFTextStripper:setEndPage($pageNo)
|
||
}
|
||
return (# db:checkstrings #) {PDFTextStripper:getText($tStripper,$pdf)}
|
||
};
|
||

|
||
(:~ Return size of $pageNo (zero based)
|
||
@result e.g. [0.0,0.0,168.0,239.52]
|
||
:)
|
||
declare function pdfbox:page-media-box($pdf as item(), $pageNo as xs:integer)
|
||
as xs:string{
|
||
PDDocument:getPage($pdf, $pageNo)
|
||
=>PDPage:getMediaBox()
|
||
=>PDRectangle:toString()
|
||
};
|
||

|
||
(:~ Version of Apache Pdfbox in use e.g. "3.0.4" :)
|
||
declare function pdfbox:version()
|
||
as xs:string{
|
||
Q{java:org.apache.pdfbox.util.Version}getVersion()
|
||
};
|
||

|
||
(:~ Convert date :)
|
||
declare %private
|
||
function pdfbox:gregToISO($item as item()?)
|
||
as xs:string?{
|
||
if(exists($item))
|
||
then Q{java:java.util.GregorianCalendar}toZonedDateTime($item)=>string()
|
||
else ()
|
||
};
|
||

|
||
(:~ fn:do-until shim for BaseX 9+10 
|
||
if fn:do-until not found use hof:until, note: $pos always zero
|
||
:)
|
||
declare %private function pdfbox:do-until(
|
||
$input as item()*, 
|
||
$action as function(item()*, xs:integer) as item()*, 
|
||
$predicate as function(item()*, xs:integer) as xs:boolean? 
|
||
) as item()*
|
||
{
|
||
let $fn:=function-lookup(QName('http://www.w3.org/2005/xpath-functions','do-until'), 3)
|
||
return if(exists($fn))
|
||
then $fn($input,$action,$predicate)
|
||
else let $hof:=function-lookup(QName('http://basex.org/modules/hof','until'), 3)
|
||
return if(exists($hof))
|
||
then $hof($predicate(?,0),$action(?,0),$input)
|
||
else error(xs:QName('pdfbox:do-until'),"No implementation do-until found")
|
||

|
||
};
|
||
</xqdoc:body></xqdoc:module><xqdoc:namespaces><xqdoc:namespace prefix="pdfbox" uri="org.expkg_zone58.Pdfbox3"/><xqdoc:namespace prefix="Loader" uri="java:org.apache.pdfbox.Loader"/><xqdoc:namespace prefix="PDFTextStripper" uri="java:org.apache.pdfbox.text.PDFTextStripper"/><xqdoc:namespace prefix="PDDocument" uri="java:org.apache.pdfbox.pdmodel.PDDocument"/><xqdoc:namespace prefix="PDDocumentCatalog" uri="java:org.apache.pdfbox.pdmodel.PDDocumentCatalog"/><xqdoc:namespace prefix="PDPageLabels" uri="java:org.apache.pdfbox.pdmodel.common.PDPageLabels"/><xqdoc:namespace prefix="PDPageLabelRange" uri="java:org.apache.pdfbox.pdmodel.common.PDPageLabelRange"/><xqdoc:namespace prefix="PageExtractor" uri="java:org.apache.pdfbox.multipdf.PageExtractor"/><xqdoc:namespace prefix="PDPage" uri="java:org.apache.pdfbox.pdmodel.PDPage"/><xqdoc:namespace prefix="PDPageTree" uri="java:org.apache.pdfbox.pdmodel.PDPageTree"/><xqdoc:namespace prefix="PDDocumentOutline" uri="java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline"/><xqdoc:namespace prefix="PDDocumentInformation" uri="java:org.apache.pdfbox.pdmodel.PDDocumentInformation"/><xqdoc:namespace prefix="PDOutlineItem" uri="java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem"/><xqdoc:namespace prefix="PDFRenderer" uri="java:org.apache.pdfbox.rendering.PDFRenderer"/><xqdoc:namespace prefix="PDMetadata" uri="java:org.apache.pdfbox.pdmodel.common.PDMetadata"/><xqdoc:namespace prefix="COSInputStream" uri="java:org.apache.pdfbox.cos.COSInputStream"/><xqdoc:namespace prefix="rdf" uri="http://www.w3.org/1999/02/22-rdf-syntax-ns#"/><xqdoc:namespace prefix="RandomAccessReadBuffer" uri="java:org.apache.pdfbox.io.RandomAccessReadBuffer"/><xqdoc:namespace prefix="RandomAccessReadBufferedFile" uri="java:org.apache.pdfbox.io.RandomAccessReadBufferedFile"/><xqdoc:namespace prefix="PDRectangle" uri="org.apache.pdfbox.pdmodel.common.PDRectangle"/><xqdoc:namespace prefix="File" uri="java:java.io.File"/><xqdoc:namespace prefix="xs" uri="http://www.w3.org/2001/XMLSchema"/><xqdoc:namespace prefix="fn" uri="http://www.w3.org/2005/xpath-functions"/><xqdoc:namespace prefix="err" uri="http://www.w3.org/2005/xqt-errors"/><xqdoc:namespace prefix="fetch" uri="http://basex.org/modules/fetch"/><xqdoc:namespace prefix="convert" uri="http://basex.org/modules/convert"/><xqdoc:namespace prefix="db" uri="http://basex.org/modules/db"/><xqdoc:namespace prefix="map" uri="http://www.w3.org/2005/xpath-functions/map"/><xqdoc:namespace prefix="array" uri="http://www.w3.org/2005/xpath-functions/array"/><xqdoc:namespace prefix="file" uri="http://expath.org/ns/file"/><xqdoc:namespace prefix="csv" uri="http://basex.org/modules/csv"/></xqdoc:namespaces><xqdoc:variables><xqdoc:variable><xqdoc:name>pdfbox:property-map</xqdoc:name><xqdoc:comment><xqdoc:description>
|
||
property access map
|
||
keys are property names,
|
||
values are sequences of functions to get property from $pdf object
|
||
</xqdoc:description></xqdoc:comment><xqdoc:annotations><xqdoc:annotation name="private"/></xqdoc:annotations><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>number-of-pages</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>number-of-bookmarks</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>number-of-labels</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>specification</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentInformation</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocumentInformation</xqdoc:uri><xqdoc:name>getTitle</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentInformation</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocumentInformation</xqdoc:uri><xqdoc:name>getAuthor</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentInformation</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocumentInformation</xqdoc:uri><xqdoc:name>getCreator</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentInformation</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocumentInformation</xqdoc:uri><xqdoc:name>getProducer</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentInformation</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocumentInformation</xqdoc:uri><xqdoc:name>getSubject</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentInformation</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocumentInformation</xqdoc:uri><xqdoc:name>getKeywords</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentInformation</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocumentInformation</xqdoc:uri><xqdoc:name>getCreationDate</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>gregToISO</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentInformation</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocumentInformation</xqdoc:uri><xqdoc:name>getModificationDate</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>gregToISO</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>labels-as-strings</xqdoc:name></xqdoc:invoked><xqdoc:body>variable $pdfbox:property-map:=map{
|
||
"#pages": pdfbox:number-of-pages#1,
|
||

|
||
"#bookmarks": pdfbox:number-of-bookmarks#1,
|
||

|
||
"#labels": pdfbox:number-of-labels#1,
|
||

|
||
"specification":pdfbox:specification#1,
|
||

|
||
"title": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getTitle#1) ,
|
||

|
||
"author": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getAuthor#1 ),
|
||

|
||
"creator": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getCreator#1),
|
||

|
||
"producer": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getProducer#1),
|
||

|
||
"subject": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getSubject#1),
|
||

|
||
"keywords": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getKeywords#1),
|
||

|
||
"creationDate": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getCreationDate#1,
|
||
pdfbox:gregToISO#1),
|
||

|
||
"modificationDate": (PDDocument:getDocumentInformation#1,
|
||
PDDocumentInformation:getModificationDate#1,
|
||
pdfbox:gregToISO#1),
|
||
"labels": pdfbox:labels-as-strings#1 
|
||
}</xqdoc:body></xqdoc:variable></xqdoc:variables><xqdoc:functions><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
"With-document" pattern: open pdf,apply $fn function, close pdf
|
||
creates a local pdfobject and ensures it is closed after use
|
||
e.g pdfbox:with-pdf("path...",pdfbox:page-text(?,5))
|
||
</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:with-pdf</xqdoc:name><xqdoc:signature>function pdfbox:with-pdf ( $src as xs:string, $fn as function(item())as item()* ) as item()* { let $pdf:=pdfbox:open($src) return try{ $fn($pdf),pdfbox:close($pdf) } catch *{ pdfbox:close($pdf),fn:error($err:code,$src || " " || $err:description) } }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>src</xqdoc:name><xqdoc:type>xs:string</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>fn</xqdoc:name><xqdoc:type>function(item())as item()*</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="*">item()</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>open</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>close</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>close</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>error</xqdoc:name></xqdoc:invoked><xqdoc:ref-variable><xqdoc:uri>http://www.w3.org/2005/xqt-errors</xqdoc:uri><xqdoc:name>code</xqdoc:name></xqdoc:ref-variable><xqdoc:ref-variable><xqdoc:uri>http://www.w3.org/2005/xqt-errors</xqdoc:uri><xqdoc:name>description</xqdoc:name></xqdoc:ref-variable><xqdoc:body>function pdfbox:with-pdf($src as xs:string,
|
||
$fn as function(item())as item()*)
|
||
as item()*{
|
||
let $pdf:=pdfbox:open($src)
|
||
return try{
|
||
$fn($pdf),pdfbox:close($pdf)
|
||
} catch *{
|
||
pdfbox:close($pdf),fn:error($err:code,$src || " " || $err:description)
|
||
}
|
||

|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
open pdf using fetch:binary, returns pdf object</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:open</xqdoc:name><xqdoc:signature>function pdfbox:open ( $pdfsrc as item() ) as item() { pdfbox:open($pdfsrc, map{}) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdfsrc</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>item()</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>open</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:open($pdfsrc as item())
|
||
as item(){
|
||
pdfbox:open($pdfsrc, map{})
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
open pdf from file/url/binary, opts may have password , returns pdf object
|
||
</xqdoc:description><xqdoc:param>$pdfsrc a fetchable url or filepath, or xs:base64Binary item</xqdoc:param><xqdoc:param>$opts options options include map {"password":}</xqdoc:param><xqdoc:custom tag="note">fetch:binary for https will use a lot of memory here</xqdoc:custom></xqdoc:comment><xqdoc:name>pdfbox:open</xqdoc:name><xqdoc:signature>function pdfbox:open ( $pdfsrc as item(), $opts as map(*) ) as item() { try{ if($pdfsrc instance of xs:base64Binary) then Loader:loadPDF( $pdfsrc,string($opts?password)) else if(starts-with($pdfsrc,"http")) then Loader:loadPDF( fetch:binary($pdfsrc),string($opts?password)) else Loader:loadPDF(RandomAccessReadBufferedFile:new($pdfsrc),string($opts?password)) } catch *{ let $loc:=if($pdfsrc instance of xs:base64Binary) then "xs:base64Binary" else $pdfsrc return error(xs:QName("pdfbox:open"),"Failed PDF load " || $loc || " " || $err:description) } }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdfsrc</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>opts</xqdoc:name><xqdoc:type>map(*)</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>item()</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.Loader</xqdoc:uri><xqdoc:name>loadPDF</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>string</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>starts-with</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.Loader</xqdoc:uri><xqdoc:name>loadPDF</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://basex.org/modules/fetch</xqdoc:uri><xqdoc:name>binary</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>string</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.Loader</xqdoc:uri><xqdoc:name>loadPDF</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.io.RandomAccessReadBufferedFile</xqdoc:uri><xqdoc:name>new</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>string</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>error</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2001/XMLSchema</xqdoc:uri><xqdoc:name>QName</xqdoc:name></xqdoc:invoked><xqdoc:ref-variable><xqdoc:uri>http://www.w3.org/2005/xqt-errors</xqdoc:uri><xqdoc:name>description</xqdoc:name></xqdoc:ref-variable><xqdoc:body>function pdfbox:open($pdfsrc as item(), $opts as map(*))
|
||
as item(){
|
||
try{
|
||

|
||
if($pdfsrc instance of xs:base64Binary)
|
||
then Loader:loadPDF( $pdfsrc,string($opts?password))
|
||
else if(starts-with($pdfsrc,"http"))
|
||
then Loader:loadPDF( fetch:binary($pdfsrc),string($opts?password))
|
||
else Loader:loadPDF(RandomAccessReadBufferedFile:new($pdfsrc),string($opts?password))
|
||

|
||
} catch *{
|
||
let $loc:=if($pdfsrc instance of xs:base64Binary)
|
||
then "xs:base64Binary"
|
||
else $pdfsrc
|
||
return error(xs:QName("pdfbox:open"),"Failed PDF load " || $loc || " " || $err:description)
|
||
}
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
The version of the PDF specification used by $pdf e.g "1.4"
|
||
returned as string to avoid float rounding issues
|
||
</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:specification</xqdoc:name><xqdoc:signature>function pdfbox:specification ( $pdf as item() ) as xs:string { PDDocument:getVersion($pdf)=>xs:decimal()=>round(4)=>string() }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getVersion</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:specification($pdf as item())
|
||
as xs:string{
|
||
PDDocument:getVersion($pdf)=>xs:decimal()=>round(4)=>string()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
Save pdf $pdf to filesystem at $savepath , returns $savepath</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:pdf-save</xqdoc:name><xqdoc:signature>function pdfbox:pdf-save ( $pdf as item(),$savepath as xs:string ) as xs:string { PDDocument:save($pdf, File:new($savepath)),$savepath }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>savepath</xqdoc:name><xqdoc:type>xs:string</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>save</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:java.io.File</xqdoc:uri><xqdoc:name>new</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:pdf-save($pdf as item(),$savepath as xs:string)
|
||
as xs:string{
|
||
PDDocument:save($pdf, File:new($savepath)),$savepath
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
Create binary representation of $pdf object as xs:base64Binary</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:binary</xqdoc:name><xqdoc:signature>function pdfbox:binary ( $pdf as item() ) as xs:base64Binary { let $bytes:=Q{java:java.io.ByteArrayOutputStream}new() let $_:=PDDocument:save($pdf, $bytes) return Q{java:java.io.ByteArrayOutputStream}toByteArray($bytes) =>convert:integers-to-base64() }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:base64Binary</xqdoc:type></xqdoc:return><xqdoc:invoked arity="0"><xqdoc:uri>java:java.io.ByteArrayOutputStream</xqdoc:uri><xqdoc:name>new</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>save</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:java.io.ByteArrayOutputStream</xqdoc:uri><xqdoc:name>toByteArray</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:binary($pdf as item())
|
||
as xs:base64Binary{
|
||
let $bytes:=Q{java:java.io.ByteArrayOutputStream}new()
|
||
let $_:=PDDocument:save($pdf, $bytes)
|
||
return Q{java:java.io.ByteArrayOutputStream}toByteArray($bytes)
|
||
=>convert:integers-to-base64()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
Release any resources related to $pdf</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:close</xqdoc:name><xqdoc:signature>function pdfbox:close ( $pdf as item() ) as empty-sequence() { (# db:wrapjava void #) { PDDocument:close($pdf) } }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>empty-sequence</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>close</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:close($pdf as item())
|
||
as empty-sequence(){
|
||
(# db:wrapjava void #) {
|
||
PDDocument:close($pdf)
|
||
}
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
Number of pages in PDF</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:number-of-pages</xqdoc:name><xqdoc:signature>function pdfbox:number-of-pages ( $pdf as item() ) as xs:integer { PDDocument:getNumberOfPages($pdf) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:integer</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getNumberOfPages</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:number-of-pages($pdf as item())
|
||
as xs:integer{
|
||
PDDocument:getNumberOfPages($pdf)
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="3"><xqdoc:comment><xqdoc:description>
|
||
Pdf page as image (zero is cover)
|
||
options.format="bmp jpg png gif" etc, options.scale= 1 is 72 dpi??</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:page-render</xqdoc:name><xqdoc:signature>function pdfbox:page-render ( $pdf as item(),$pageNo as xs:integer,$options as map(*) ) as xs:base64Binary { let $options := map:merge(($options,map{"format":"jpg","scale":1})) let $bufferedImage := PDFRenderer:new($pdf) =>PDFRenderer:renderImage($pageNo,$options?scale) let $bytes := Q{java:java.io.ByteArrayOutputStream}new() let $_ := Q{java:javax.imageio.ImageIO}write($bufferedImage ,$options?format, $bytes) return Q{java:java.io.ByteArrayOutputStream}toByteArray($bytes) =>convert:integers-to-base64() }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>pageNo</xqdoc:name><xqdoc:type>xs:integer</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>options</xqdoc:name><xqdoc:type>map(*)</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:base64Binary</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions/map</xqdoc:uri><xqdoc:name>merge</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.rendering.PDFRenderer</xqdoc:uri><xqdoc:name>new</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="0"><xqdoc:uri>java:java.io.ByteArrayOutputStream</xqdoc:uri><xqdoc:name>new</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="3"><xqdoc:uri>java:javax.imageio.ImageIO</xqdoc:uri><xqdoc:name>write</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:java.io.ByteArrayOutputStream</xqdoc:uri><xqdoc:name>toByteArray</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:page-render($pdf as item(),$pageNo as xs:integer,$options as map(*))
|
||
as xs:base64Binary{
|
||
let $options := map:merge(($options,map{"format":"jpg","scale":1}))
|
||
let $bufferedImage := PDFRenderer:new($pdf)
|
||
=>PDFRenderer:renderImage($pageNo,$options?scale)
|
||
let $bytes := Q{java:java.io.ByteArrayOutputStream}new()
|
||
let $_ := Q{java:javax.imageio.ImageIO}write($bufferedImage ,$options?format, $bytes)
|
||
return Q{java:java.io.ByteArrayOutputStream}toByteArray($bytes)
|
||
=>convert:integers-to-base64()
|
||

|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="0"><xqdoc:comment><xqdoc:description>
|
||
known property names sorted</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:property-names</xqdoc:name><xqdoc:signature>function pdfbox:property-names ( ) as xs:string* { $pdfbox:property-map=>map:keys()=>sort() }</xqdoc:signature><xqdoc:return><xqdoc:type occurrence="*">xs:string</xqdoc:type></xqdoc:return><xqdoc:ref-variable><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>property-map</xqdoc:name></xqdoc:ref-variable><xqdoc:body>function pdfbox:property-names() 
|
||
as xs:string*{
|
||
$pdfbox:property-map=>map:keys()=>sort()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
return value of $property for $pdf</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:property</xqdoc:name><xqdoc:signature>function pdfbox:property ( $pdf as item(),$property as xs:string ) as item()* { let $fns:= $pdfbox:property-map($property) return if(exists($fns)) then fold-left($fns, $pdf, function($result,$this as function(*)){$result!$this(.)}) else error(xs:QName('pdfbox:property'),concat("Property '",$property,"' not defined.")) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>property</xqdoc:name><xqdoc:type>xs:string</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="*">item()</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="3"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>fold-left</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>error</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2001/XMLSchema</xqdoc:uri><xqdoc:name>QName</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="3"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>concat</xqdoc:name></xqdoc:invoked><xqdoc:ref-variable><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>property-map</xqdoc:name></xqdoc:ref-variable><xqdoc:body>function pdfbox:property($pdf as item(),$property as xs:string)
|
||
as item()*{
|
||
let $fns:= $pdfbox:property-map($property)
|
||
return if(exists($fns))
|
||
then fold-left($fns, 
|
||
$pdf, 
|
||
function($result,$this as function(*)){$result!$this(.)})
|
||
else error(xs:QName('pdfbox:property'),concat("Property '",$property,"' not defined."))
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
summary CSV style info for all properties for $pdfpaths
|
||
</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:report</xqdoc:name><xqdoc:signature>function pdfbox:report ( $pdfpaths as xs:string* ) as map(*) { pdfbox:report($pdfpaths,pdfbox:property-names()) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdfpaths</xqdoc:name><xqdoc:type occurrence="*">xs:string</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>report</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="0"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>property-names</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:report($pdfpaths as xs:string*)
|
||
as map(*){
|
||
pdfbox:report($pdfpaths,pdfbox:property-names())
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
summary CSV style info for named properties for $pdfpaths
|
||
</xqdoc:description><xqdoc:see>https://docs.basex.org/main/CSV_Functions#xquery</xqdoc:see></xqdoc:comment><xqdoc:name>pdfbox:report</xqdoc:name><xqdoc:signature>function pdfbox:report ( $pdfpaths as item()*, $properties as xs:string* ) as map(*) { map{"names": array{"path",$properties}, "records": for $path in $pdfpaths let $name:=if($path instance of xs:base64Binary) then "binary" else $path return try{ let $pdf:=pdfbox:open($path) return (fold-left($properties, array{$name}, function($result as array(*),$prop as xs:string){ array:append($result, string(pdfbox:property($pdf, $prop)))} ), pdfbox:close($pdf) ) } catch *{ fold-left($properties, array{$name}, function($result as array(*),$prop as xs:string){ array:append($result, "#ERROR")} ) } } }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdfpaths</xqdoc:name><xqdoc:type occurrence="*">item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>properties</xqdoc:name><xqdoc:type occurrence="*">xs:string</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>open</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="3"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>fold-left</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions/array</xqdoc:uri><xqdoc:name>append</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>string</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>property</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>close</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="3"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>fold-left</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions/array</xqdoc:uri><xqdoc:name>append</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:report($pdfpaths as item()*, $properties as xs:string*)
|
||
as map(*){
|
||
map{"names": array{"path",$properties},
|
||

|
||
"records": for $path in $pdfpaths
|
||
let $name:=if($path instance of xs:base64Binary) then "binary" else $path
|
||
return try{
|
||
let $pdf:=pdfbox:open($path)
|
||
return (fold-left($properties,
|
||
array{$name},
|
||
function($result as array(*),$prop as xs:string){
|
||
array:append($result, string(pdfbox:property($pdf, $prop)))}
|
||
), pdfbox:close($pdf)
|
||
)
|
||
} catch *{
|
||
fold-left($properties,
|
||
array{$name},
|
||
function($result as array(*),$prop as xs:string){
|
||
array:append($result, "#ERROR")}
|
||
)
|
||
}
|
||

|
||
}
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
convenience function to save report() data to file</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:report-save</xqdoc:name><xqdoc:signature>function pdfbox:report-save ( $data as map(*),$dest as xs:string ) as empty-sequence() { let $opts := map { "format":"xquery", "header":"yes", "separator" : "," } return file:write-text($dest,csv:serialize($data,$opts)) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>data</xqdoc:name><xqdoc:type>map(*)</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>dest</xqdoc:name><xqdoc:type>xs:string</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>empty-sequence</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>http://expath.org/ns/file</xqdoc:uri><xqdoc:name>write-text</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://basex.org/modules/csv</xqdoc:uri><xqdoc:name>serialize</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:report-save($data as map(*),$dest as xs:string)
|
||
as empty-sequence(){
|
||
let $opts := map { "format":"xquery", "header":"yes", "separator" : "," }
|
||
return file:write-text($dest,csv:serialize($data,$opts))
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
number of outline items</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:number-of-bookmarks</xqdoc:name><xqdoc:signature>function pdfbox:number-of-bookmarks ( $pdf as item() ) as xs:integer { let $xml:=pdfbox:outline-xml($pdf) return count($xml//bookmark) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:integer</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>outline-xml</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>count</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:number-of-bookmarks($pdf as item())
|
||
as xs:integer{
|
||
let $xml:=pdfbox:outline-xml($pdf)
|
||
return count($xml//bookmark)
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
XMP metadata as "RDF" document
|
||
</xqdoc:description><xqdoc:custom tag="note">usually rdf:RDF root, but sometimes x:xmpmeta</xqdoc:custom></xqdoc:comment><xqdoc:name>pdfbox:metadata</xqdoc:name><xqdoc:signature>function pdfbox:metadata ( $pdf as item() ) as document-node(element(*))? { let $m:=PDDocument:getDocumentCatalog($pdf) =>PDDocumentCatalog:getMetadata() return if(exists($m)) then let $is:=PDMetadata:exportXMPMetadata($m) return pdfbox:do-until( map{"n":0,"data":""}, function($input,$pos ) { pdfbox:read-stream($is,$input?data)}, function($output,$pos) { $output?n eq -1 } )?data=>parse-xml() else () }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="?">document-node(element(*))</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentCatalog</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDMetadata</xqdoc:uri><xqdoc:name>exportXMPMetadata</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="3"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>do-until</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>read-stream</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:metadata($pdf as item())
|
||
as document-node(element(*))?
|
||
{
|
||
let $m:=PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getMetadata()
|
||
return if(exists($m))
|
||
then 
|
||
let $is:=PDMetadata:exportXMPMetadata($m)
|
||
return pdfbox:do-until(
|
||
map{"n":0,"data":""},
|
||

|
||
function($input,$pos ) { pdfbox:read-stream($is,$input?data)},
|
||

|
||
function($output,$pos) { $output?n eq -1 } 
|
||
)?data=>parse-xml()
|
||
else ()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
read next block from XMP stream</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:read-stream</xqdoc:name><xqdoc:annotations><xqdoc:annotation name="private"/></xqdoc:annotations><xqdoc:signature>function pdfbox:read-stream ( $is,$read as xs:string ) as map(*) { let $blen:=4096 let $buff:=Q{java:java.util.Arrays}copyOf(array{xs:byte(0)},$blen) let $n:= COSInputStream:read($is,$buff,xs:int(0),xs:int($blen)) let $data:=convert:integers-to-base64(subsequence($buff,1,$n))=>convert:binary-to-string() return map{"n":$n, "data": $read || $data} }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>is</xqdoc:name></xqdoc:parameter><xqdoc:parameter><xqdoc:name>read</xqdoc:name><xqdoc:type>xs:string</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>java:java.util.Arrays</xqdoc:uri><xqdoc:name>copyOf</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2001/XMLSchema</xqdoc:uri><xqdoc:name>byte</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="4"><xqdoc:uri>java:org.apache.pdfbox.cos.COSInputStream</xqdoc:uri><xqdoc:name>read</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2001/XMLSchema</xqdoc:uri><xqdoc:name>int</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2001/XMLSchema</xqdoc:uri><xqdoc:name>int</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://basex.org/modules/convert</xqdoc:uri><xqdoc:name>integers-to-base64</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="3"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>subsequence</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:read-stream($is,$read as xs:string)
|
||
as map(*){
|
||
let $blen:=4096
|
||
let $buff:=Q{java:java.util.Arrays}copyOf(array{xs:byte(0)},$blen)
|
||
let $n:= COSInputStream:read($is,$buff,xs:int(0),xs:int($blen))
|
||
let $data:=convert:integers-to-base64(subsequence($buff,1,$n))=>convert:binary-to-string()
|
||
return map{"n":$n, "data": $read || $data}
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
outline for $pdf as map()*</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:outline</xqdoc:name><xqdoc:signature>function pdfbox:outline ( $pdf as item() ) as map(*)* { (# db:wrapjava some #) { let $outline:= PDDocument:getDocumentCatalog($pdf) =>PDDocumentCatalog:getDocumentOutline() return if(exists($outline)) then pdfbox:outline($pdf,PDOutlineItem:getFirstChild($outline)) } }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="*">map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentCatalog</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>outline</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem</xqdoc:uri><xqdoc:name>getFirstChild</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:outline($pdf as item())
|
||
as map(*)*{
|
||
(# db:wrapjava some #) {
|
||
let $outline:=
|
||
PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getDocumentOutline()
|
||

|
||
return if(exists($outline))
|
||
then pdfbox:outline($pdf,PDOutlineItem:getFirstChild($outline)) 
|
||
}
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
return bookmark info for children of $outlineItem as seq of maps</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:outline</xqdoc:name><xqdoc:signature>function pdfbox:outline ( $pdf as item(),$outlineItem as item()? ) as map(*)* { let $find as map(*):=pdfbox:outline_($pdf ,$outlineItem) return map:get($find,"list") }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>outlineItem</xqdoc:name><xqdoc:type occurrence="?">item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="*">map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>outline_</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions/map</xqdoc:uri><xqdoc:name>get</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:outline($pdf as item(),$outlineItem as item()?)
|
||
as map(*)*{
|
||
let $find as map(*):=pdfbox:outline_($pdf ,$outlineItem)
|
||
return map:get($find,"list")
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
BaseX bug 10.7? error if inlined in outline</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:outline_</xqdoc:name><xqdoc:annotations><xqdoc:annotation name="private"/></xqdoc:annotations><xqdoc:signature>function pdfbox:outline_ ( $pdf as item(),$outlineItem as item()? ) as map(*) { pdfbox:do-until( map{"list":(),"this":$outlineItem}, function($input,$pos ) { let $bk:= pdfbox:bookmark($input?this,$pdf) let $bk:= if($bk?hasChildren) then let $kids:=pdfbox:outline($pdf,PDOutlineItem:getFirstChild($input?this)) return map:merge(($bk,map:entry("children",$kids))) else $bk return map{ "list": ($input?list, $bk), "this": PDOutlineItem:getNextSibling($input?this)} }, function($output,$pos) { empty($output?this) } ) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>outlineItem</xqdoc:name><xqdoc:type occurrence="?">item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="3"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>do-until</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>bookmark</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>outline</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem</xqdoc:uri><xqdoc:name>getFirstChild</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions/map</xqdoc:uri><xqdoc:name>merge</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions/map</xqdoc:uri><xqdoc:name>entry</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem</xqdoc:uri><xqdoc:name>getNextSibling</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>empty</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:outline_($pdf as item(),$outlineItem as item()?)
|
||
as map(*){
|
||
pdfbox:do-until(
|
||

|
||
map{"list":(),"this":$outlineItem},
|
||

|
||
function($input,$pos ) { 
|
||
let $bk:= pdfbox:bookmark($input?this,$pdf)
|
||
let $bk:= if($bk?hasChildren)
|
||
then let $kids:=pdfbox:outline($pdf,PDOutlineItem:getFirstChild($input?this))
|
||
return map:merge(($bk,map:entry("children",$kids)))
|
||
else $bk 
|
||
return map{
|
||
"list": ($input?list, $bk),
|
||
"this": PDOutlineItem:getNextSibling($input?this)}
|
||
},
|
||

|
||
function($output,$pos) { empty($output?this) } 
|
||
)
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
PDF outline in xml format</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:outline-xml</xqdoc:name><xqdoc:signature>function pdfbox:outline-xml ( $pdf as item() ) as element(outline)? { let $outline:=pdfbox:outline($pdf) return if(exists($outline)) then <outline>{$outline!pdfbox:bookmark-xml(.)}</outline> else () }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="?">element(outline)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>outline</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>bookmark-xml</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:outline-xml($pdf as item())
|
||
as element(outline)?{
|
||
let $outline:=pdfbox:outline($pdf)
|
||
return if(exists($outline))
|
||
then <outline>{$outline!pdfbox:bookmark-xml(.)}</outline>
|
||
else ()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
Convert outline map to XML</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:bookmark-xml</xqdoc:name><xqdoc:annotations><xqdoc:annotation name="private"/></xqdoc:annotations><xqdoc:signature>function pdfbox:bookmark-xml ( $outline as map(*)* ) as element(bookmark)* { $outline! <bookmark title="{?title}" index="{?index}"> {?children!pdfbox:bookmark-xml(.)} </bookmark> }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>outline</xqdoc:name><xqdoc:type occurrence="*">map(*)</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="*">element(bookmark)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>bookmark-xml</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:bookmark-xml($outline as map(*)*)
|
||
as element(bookmark)*
|
||
{
|
||
$outline!
|
||
<bookmark title="{?title}" index="{?index}">
|
||
{?children!pdfbox:bookmark-xml(.)}
|
||
</bookmark>
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
Return bookmark info for $bookmark
|
||
</xqdoc:description><xqdoc:return>map{index:..,title:..,hasChildren:..}</xqdoc:return></xqdoc:comment><xqdoc:name>pdfbox:bookmark</xqdoc:name><xqdoc:annotations><xqdoc:annotation name="private"/></xqdoc:annotations><xqdoc:signature>function pdfbox:bookmark ( $bookmark as item(),$pdf as item() ) as map(*) { map{ "index": PDOutlineItem:findDestinationPage($bookmark,$pdf)=>pdfbox:find-page($pdf), "title": (# db:checkstrings #) {PDOutlineItem:getTitle($bookmark)} (:=>translate("<22>",""), :), "hasChildren": PDOutlineItem:hasChildren($bookmark) } }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>bookmark</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem</xqdoc:uri><xqdoc:name>findDestinationPage</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem</xqdoc:uri><xqdoc:name>getTitle</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem</xqdoc:uri><xqdoc:name>hasChildren</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:bookmark($bookmark as item(),$pdf as item())
|
||
as map(*)
|
||
{
|
||
map{ 
|
||
"index": PDOutlineItem:findDestinationPage($bookmark,$pdf)=>pdfbox:find-page($pdf),
|
||
"title": (# db:checkstrings #) {PDOutlineItem:getTitle($bookmark)}
|
||
(:=>translate("<22>",""), :),
|
||
"hasChildren": PDOutlineItem:hasChildren($bookmark)
|
||
}
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
pageIndex of $page in $pdf</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:find-page</xqdoc:name><xqdoc:signature>function pdfbox:find-page ( $page as item()? (: as java:org.apache.pdfbox.pdmodel.PDPage :), $pdf as item() ) as item()? { if(exists($page)) then PDDocument:getDocumentCatalog($pdf) =>PDDocumentCatalog:getPages() =>PDPageTree:indexOf($page) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>page</xqdoc:name><xqdoc:type occurrence="?">item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="?">item()</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentCatalog</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:find-page(
|
||
$page as item()? (: as java:org.apache.pdfbox.pdmodel.PDPage :),
|
||
$pdf as item())
|
||
as item()?
|
||
{
|
||
if(exists($page))
|
||
then PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPages()
|
||
=>PDPageTree:indexOf($page)
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="3"><xqdoc:comment><xqdoc:description>
|
||
Return new PDF doc with pages from $start to $end as xs:base64Binary, (1 based)
|
||
</xqdoc:description><xqdoc:param>$start first page to include</xqdoc:param><xqdoc:param>$end last page to include</xqdoc:param></xqdoc:comment><xqdoc:name>pdfbox:extract-range</xqdoc:name><xqdoc:signature>function pdfbox:extract-range ( $pdf as item(), $start as xs:integer,$end as xs:integer ) as xs:base64Binary { let $a:=PageExtractor:new($pdf, $start, $end) =>PageExtractor:extract() return (pdfbox:binary($a),pdfbox:close($a)) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>start</xqdoc:name><xqdoc:type>xs:integer</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>end</xqdoc:name><xqdoc:type>xs:integer</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:base64Binary</xqdoc:type></xqdoc:return><xqdoc:invoked arity="3"><xqdoc:uri>java:org.apache.pdfbox.multipdf.PageExtractor</xqdoc:uri><xqdoc:name>new</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>binary</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>close</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:extract-range($pdf as item(), 
|
||
$start as xs:integer,$end as xs:integer)
|
||
as xs:base64Binary
|
||
{
|
||
let $a:=PageExtractor:new($pdf, $start, $end) =>PageExtractor:extract()
|
||
return (pdfbox:binary($a),pdfbox:close($a)) 
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
The number of labels defined in PDF</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:number-of-labels</xqdoc:name><xqdoc:signature>function pdfbox:number-of-labels ( $pdf as item() ) as xs:integer { let $labels:=PDDocument:getDocumentCatalog($pdf) =>PDDocumentCatalog:getPageLabels() return if(exists($labels)) then PDPageLabels:getPageRangeCount($labels) else 0 }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:integer</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentCatalog</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabels</xqdoc:uri><xqdoc:name>getPageRangeCount</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:number-of-labels($pdf as item())
|
||
as xs:integer
|
||
{
|
||
let $labels:=PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
return if(exists($labels)) 
|
||
then PDPageLabels:getPageRangeCount($labels)
|
||
else 0
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
pageLabel for every page from derived from page-ranges
|
||
The returned sequence will contain at MOST as much entries as the document has pages.
|
||
</xqdoc:description><xqdoc:see>https://www.w3.org/TR/WCAG20-TECHS/PDF17.html#PDF17-examples</xqdoc:see><xqdoc:see>https://codereview.stackexchange.com/questions/286078/java-code-showing-page-labels-from-pdf-files</xqdoc:see></xqdoc:comment><xqdoc:name>pdfbox:labels-by-page</xqdoc:name><xqdoc:signature>function pdfbox:labels-by-page ( $pdf as item() ) as xs:string* { PDDocument:getDocumentCatalog($pdf) =>PDDocumentCatalog:getPageLabels() =>PDPageLabels:getLabelsByPageIndices() }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="*">xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentCatalog</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:labels-by-page($pdf as item())
|
||
as xs:string*
|
||
{
|
||
PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
=>PDPageLabels:getLabelsByPageIndices()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
sequence of label ranges defined in PDF as formatted strings</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:labels-as-strings</xqdoc:name><xqdoc:signature>function pdfbox:labels-as-strings ( $pdf as item() ) as xs:string { let $pagelabels:=PDDocument:getDocumentCatalog($pdf) =>PDDocumentCatalog:getPageLabels() return $pagelabels !(0 to pdfbox:number-of-pages($pdf)-1) !pdfbox:label-as-string($pagelabels,.)=>string-join(",") }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentCatalog</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>number-of-pages</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>label-as-string</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:labels-as-strings($pdf as item())
|
||
as xs:string{
|
||
let $pagelabels:=PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
return $pagelabels
|
||
!(0 to pdfbox:number-of-pages($pdf)-1)
|
||
!pdfbox:label-as-string($pagelabels,.)=>string-join(",")
|
||

|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
get pagelabels exist</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:page-labels</xqdoc:name><xqdoc:signature>function pdfbox:page-labels ( $pdf ) { PDDocument:getDocumentCatalog($pdf) =>PDDocumentCatalog:getPageLabels() }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name></xqdoc:parameter></xqdoc:parameters><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentCatalog</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:page-labels($pdf)
|
||
{
|
||
PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
label for $page formated as string</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:label-as-string</xqdoc:name><xqdoc:signature>function pdfbox:label-as-string ( $pagelabels,$page as xs:integer ) as xs:string? { let $label:=PDPageLabels:getPageLabelRange($pagelabels,$page) return if(empty($label)) then () else let $start:= PDPageLabelRange:getStart($label) let $style := PDPageLabelRange:getStyle($label) let $prefix:= PDPageLabelRange:getPrefix($label) return string-join(($page, if(empty($style)) then "-" else $style, if(($start eq 1)) then "" else $start, if(exists($prefix)) then '*' || $prefix (:TODO double " :) )) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pagelabels</xqdoc:name></xqdoc:parameter><xqdoc:parameter><xqdoc:name>page</xqdoc:name><xqdoc:type>xs:integer</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="?">xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabels</xqdoc:uri><xqdoc:name>getPageLabelRange</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>empty</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabelRange</xqdoc:uri><xqdoc:name>getStart</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabelRange</xqdoc:uri><xqdoc:name>getStyle</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabelRange</xqdoc:uri><xqdoc:name>getPrefix</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>string-join</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>empty</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:label-as-string($pagelabels,$page as xs:integer)
|
||
as xs:string?{
|
||
let $label:=PDPageLabels:getPageLabelRange($pagelabels,$page)
|
||
return if(empty($label))
|
||
then ()
|
||
else
|
||
let $start:= PDPageLabelRange:getStart($label)
|
||
let $style := PDPageLabelRange:getStyle($label)
|
||
let $prefix:= PDPageLabelRange:getPrefix($label) 
|
||
return string-join(($page, 
|
||
if(empty($style)) then "-" else $style,
|
||
if(($start eq 1)) then "" else $start,
|
||
if(exists($prefix)) then '*' || $prefix (:TODO double " :)
|
||
))
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
sequence of maps for each label in</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:labels-as-map</xqdoc:name><xqdoc:signature>function pdfbox:labels-as-map ( $pdf as item() ) as map(*)* { let $pagelabels:=PDDocument:getDocumentCatalog($pdf) =>PDDocumentCatalog:getPageLabels() return $pagelabels !(0 to pdfbox:number-of-pages($pdf)-1) !pdfbox:label-as-map($pagelabels,.) }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="*">map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getDocumentCatalog</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>number-of-pages</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>org.expkg_zone58.Pdfbox3</xqdoc:uri><xqdoc:name>label-as-map</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:labels-as-map($pdf as item())
|
||
as map(*)*{
|
||
let $pagelabels:=PDDocument:getDocumentCatalog($pdf)
|
||
=>PDDocumentCatalog:getPageLabels()
|
||
return $pagelabels
|
||
!(0 to pdfbox:number-of-pages($pdf)-1)
|
||
!pdfbox:label-as-map($pagelabels,.)
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
express label/page-range for $page as map</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:label-as-map</xqdoc:name><xqdoc:signature>function pdfbox:label-as-map ( $pagelabels,$page as xs:integer ) as map(*) { let $label:=PDPageLabels:getPageLabelRange($pagelabels,$page) return if(empty($label)) then () else map{ "index": $page, "prefix": PDPageLabelRange:getPrefix($label), "start": PDPageLabelRange:getStart($label), "style": PDPageLabelRange:getStyle($label) } }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pagelabels</xqdoc:name></xqdoc:parameter><xqdoc:parameter><xqdoc:name>page</xqdoc:name><xqdoc:type>xs:integer</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>map(*)</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabels</xqdoc:uri><xqdoc:name>getPageLabelRange</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>empty</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabelRange</xqdoc:uri><xqdoc:name>getPrefix</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabelRange</xqdoc:uri><xqdoc:name>getStart</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.common.PDPageLabelRange</xqdoc:uri><xqdoc:name>getStyle</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:label-as-map($pagelabels,$page as xs:integer)
|
||
as map(*)
|
||
{
|
||
let $label:=PDPageLabels:getPageLabelRange($pagelabels,$page)
|
||
return if(empty($label))
|
||
then ()
|
||
else map{
|
||
"index": $page,
|
||
"prefix": PDPageLabelRange:getPrefix($label),
|
||
"start": PDPageLabelRange:getStart($label),
|
||
"style": PDPageLabelRange:getStyle($label)
|
||
}
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
return text on $pageNo</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:page-text</xqdoc:name><xqdoc:signature>function pdfbox:page-text ( $pdf as item(), $pageNo as xs:integer ) as xs:string { let $tStripper := (# db:wrapjava instance #) { PDFTextStripper:new() => PDFTextStripper:setStartPage($pageNo) => PDFTextStripper:setEndPage($pageNo) } return (# db:checkstrings #) {PDFTextStripper:getText($tStripper,$pdf)} }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>pageNo</xqdoc:name><xqdoc:type>xs:integer</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="0"><xqdoc:uri>java:org.apache.pdfbox.text.PDFTextStripper</xqdoc:uri><xqdoc:name>new</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.text.PDFTextStripper</xqdoc:uri><xqdoc:name>getText</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:page-text($pdf as item(), $pageNo as xs:integer)
|
||
as xs:string{
|
||
let $tStripper := (# db:wrapjava instance #) {
|
||
PDFTextStripper:new()
|
||
=> PDFTextStripper:setStartPage($pageNo)
|
||
=> PDFTextStripper:setEndPage($pageNo)
|
||
}
|
||
return (# db:checkstrings #) {PDFTextStripper:getText($tStripper,$pdf)}
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="2"><xqdoc:comment><xqdoc:description>
|
||
Return size of $pageNo (zero based)
|
||
</xqdoc:description><xqdoc:custom tag="result">e.g. [0.0,0.0,168.0,239.52]</xqdoc:custom></xqdoc:comment><xqdoc:name>pdfbox:page-media-box</xqdoc:name><xqdoc:signature>function pdfbox:page-media-box ( $pdf as item(), $pageNo as xs:integer ) as xs:string { PDDocument:getPage($pdf, $pageNo) =>PDPage:getMediaBox() =>PDRectangle:toString() }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>pdf</xqdoc:name><xqdoc:type>item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>pageNo</xqdoc:name><xqdoc:type>xs:integer</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type>xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>java:org.apache.pdfbox.pdmodel.PDDocument</xqdoc:uri><xqdoc:name>getPage</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:page-media-box($pdf as item(), $pageNo as xs:integer)
|
||
as xs:string{
|
||
PDDocument:getPage($pdf, $pageNo)
|
||
=>PDPage:getMediaBox()
|
||
=>PDRectangle:toString()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="0"><xqdoc:comment><xqdoc:description>
|
||
Version of Apache Pdfbox in use e.g. "3.0.4"</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:version</xqdoc:name><xqdoc:signature>function pdfbox:version ( ) as xs:string { Q{java:org.apache.pdfbox.util.Version}getVersion() }</xqdoc:signature><xqdoc:return><xqdoc:type>xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="0"><xqdoc:uri>java:org.apache.pdfbox.util.Version</xqdoc:uri><xqdoc:name>getVersion</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:version()
|
||
as xs:string{
|
||
Q{java:org.apache.pdfbox.util.Version}getVersion()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="1"><xqdoc:comment><xqdoc:description>
|
||
Convert date</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:gregToISO</xqdoc:name><xqdoc:annotations><xqdoc:annotation name="private"/></xqdoc:annotations><xqdoc:signature>function pdfbox:gregToISO ( $item as item()? ) as xs:string? { if(exists($item)) then Q{java:java.util.GregorianCalendar}toZonedDateTime($item)=>string() else () }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>item</xqdoc:name><xqdoc:type occurrence="?">item()</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="?">xs:string</xqdoc:type></xqdoc:return><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>java:java.util.GregorianCalendar</xqdoc:uri><xqdoc:name>toZonedDateTime</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:gregToISO($item as item()?)
|
||
as xs:string?{
|
||
if(exists($item))
|
||
then Q{java:java.util.GregorianCalendar}toZonedDateTime($item)=>string()
|
||
else ()
|
||
}</xqdoc:body></xqdoc:function><xqdoc:function arity="3"><xqdoc:comment><xqdoc:description>
|
||
fn:do-until shim for BaseX 9+10
|
||
if fn:do-until not found use hof:until, note: $pos always zero
|
||
</xqdoc:description></xqdoc:comment><xqdoc:name>pdfbox:do-until</xqdoc:name><xqdoc:annotations><xqdoc:annotation name="private"/></xqdoc:annotations><xqdoc:signature>function pdfbox:do-until ( $input as item()*, $action as function(item()*, xs:integer) as item()*, $predicate as function(item()*, xs:integer) as xs:boolean? ) as item()* { let $fn:=function-lookup(QName('http://www.w3.org/2005/xpath-functions','do-until'), 3) return if(exists($fn)) then $fn($input,$action,$predicate) else let $hof:=function-lookup(QName('http://basex.org/modules/hof','until'), 3) return if(exists($hof)) then $hof($predicate(?,0),$action(?,0),$input) else error(xs:QName('pdfbox:do-until'),"No implementation do-until found") }</xqdoc:signature><xqdoc:parameters><xqdoc:parameter><xqdoc:name>input</xqdoc:name><xqdoc:type occurrence="*">item()</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>action</xqdoc:name><xqdoc:type>function(item()*, xs:integer) as item()*</xqdoc:type></xqdoc:parameter><xqdoc:parameter><xqdoc:name>predicate</xqdoc:name><xqdoc:type>function(item()*, xs:integer) as xs:boolean?</xqdoc:type></xqdoc:parameter></xqdoc:parameters><xqdoc:return><xqdoc:type occurrence="*">item()</xqdoc:type></xqdoc:return><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>function-lookup</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>QName</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>function-lookup</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>QName</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>exists</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="2"><xqdoc:uri>http://www.w3.org/2005/xpath-functions</xqdoc:uri><xqdoc:name>error</xqdoc:name></xqdoc:invoked><xqdoc:invoked arity="1"><xqdoc:uri>http://www.w3.org/2001/XMLSchema</xqdoc:uri><xqdoc:name>QName</xqdoc:name></xqdoc:invoked><xqdoc:body>function pdfbox:do-until(
|
||
$input as item()*, 
|
||
$action as function(item()*, xs:integer) as item()*, 
|
||
$predicate as function(item()*, xs:integer) as xs:boolean? 
|
||
) as item()*
|
||
{
|
||
let $fn:=function-lookup(QName('http://www.w3.org/2005/xpath-functions','do-until'), 3)
|
||
return if(exists($fn))
|
||
then $fn($input,$action,$predicate)
|
||
else let $hof:=function-lookup(QName('http://basex.org/modules/hof','until'), 3)
|
||
return if(exists($hof))
|
||
then $hof($predicate(?,0),$action(?,0),$input)
|
||
else error(xs:QName('pdfbox:do-until'),"No implementation do-until found")
|
||

|
||
}</xqdoc:body></xqdoc:function></xqdoc:functions></xqdoc:xqdoc> |