Package net.webpdf.parameter.schema.extraction.info

Class AttachmentType

java.lang.Object

net.webpdf.parameter.schema.extraction.info.AttachmentType

public class AttachmentType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">This type is used to describe an attachment, that has been embedded in a PDF file.
                     The attachment itself may have connected document information, in that case the "document" element will be set.
                 </p>
 

Java class for AttachmentType complex type

.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="AttachmentType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://schema.webpdf.de/1.0/extraction/info}document" minOccurs="0"/>
       </sequence>
       <attribute name="objectKey" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="number">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="1"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="page" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}int">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="size" default="0">
         <simpleType>
           <restriction base="{http://www.w3.org/2001/XMLSchema}double">
             <minInclusive value="0"/>
           </restriction>
         </simpleType>
       </attribute>
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="mimeType" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="folderId" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	<?
protected DocumentType	documentType	<?
protected Integer	folderId	<?
protected String	mimeType	<?
protected String	name	<?
protected Integer	number	<?
protected String	objectKey	<?
protected Integer	page	<?
protected Double	size	<?

Constructor Summary

Constructors

Constructor	Description
AttachmentType()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	<?
DocumentType	getDocumentType()	<?
int	getFolderId()	<?
String	getMimeType()	<?
String	getName()	<?
Integer	getNumber()	<?
String	getObjectKey()	<?
int	getPage()	<?
double	getSize()	<?
void	setDescription(String value)	Sets the value of the description property.
void	setDocumentType(DocumentType value)	Sets the value of the documentType property.
void	setFolderId(Integer value)	Sets the value of the folderId property.
void	setMimeType(String value)	Sets the value of the mimeType property.
void	setName(String value)	Sets the value of the name property.
void	setNumber(Integer value)	Sets the value of the number property.
void	setObjectKey(String value)	Sets the value of the objectKey property.
void	setPage(Integer value)	Sets the value of the page property.
void	setSize(Double value)	Sets the value of the size property.

Methods inherited from class java.lang.Object

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

Field Detail

documentType

protected DocumentType documentType

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">A document element that describes the content and properties of the PDF document as metadata.</p>
 

objectKey

protected String objectKey

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the attachment.
 
                         <b>Info:</b>
                         A PDF objects ID consists of two number, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>
 

number

protected Integer number

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The position number of the attachment in the embedded files of the document.</p>
 

page

protected Integer page

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The page (if any), the attachment is placed on.</p>
 

name

protected String name

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The file name of the attachment.</p>
 

size

protected Double size

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The byte size of the attachment.</p>
 

description

protected String description

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The file description of the attachment.</p>
 

mimeType

protected String mimeType

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The attachment's MIME type.</p>
 

folderId

protected Integer folderId

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The numeric ID of the folder containing the attachment.
                         (This is only relevant for PDF Collections/Portfolios - otherwise attachments may not be arranged in a folder tree.)
                     </p>
 

Constructor Detail

AttachmentType

public AttachmentType()

Method Detail

getDocumentType

public DocumentType getDocumentType()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">A document element that describes the content and properties of the PDF document as metadata.</p>
 

Returns:

possible object is DocumentType

setDocumentType

public void setDocumentType(DocumentType value)

Sets the value of the documentType property.

Parameters:

value - allowed object is DocumentType

See Also:

getDocumentType()

getObjectKey

public String getObjectKey()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The object ID of the attachment.
 
                         <b>Info:</b>
                         A PDF objects ID consists of two number, where the first number selects the object's number and the second the "generation" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.
                     </p>
 

Returns:

possible object is String

setObjectKey

public void setObjectKey(String value)

Sets the value of the objectKey property.

Parameters:

value - allowed object is String

See Also:

getObjectKey()

getNumber

public Integer getNumber()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The position number of the attachment in the embedded files of the document.</p>
 

Returns:

possible object is Integer

setNumber

public void setNumber(Integer value)

Sets the value of the number property.

Parameters:

value - allowed object is Integer

See Also:

getNumber()

getPage

public int getPage()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The page (if any), the attachment is placed on.</p>
 

Returns:

possible object is Integer

setPage

public void setPage(Integer value)

Sets the value of the page property.

Parameters:

value - allowed object is Integer

See Also:

getPage()

getName

public String getName()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The file name of the attachment.</p>
 

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

See Also:

getName()

getSize

public double getSize()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The byte size of the attachment.</p>
 

Returns:

possible object is Double

setSize

public void setSize(Double value)

Sets the value of the size property.

Parameters:

value - allowed object is Double

See Also:

getSize()

getDescription

public String getDescription()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The file description of the attachment.</p>
 

Returns:

possible object is String

setDescription

public void setDescription(String value)

Sets the value of the description property.

Parameters:

value - allowed object is String

See Also:

getDescription()

getMimeType

public String getMimeType()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The attachment's MIME type.</p>
 

Returns:

possible object is String

setMimeType

public void setMimeType(String value)

Sets the value of the mimeType property.

Parameters:

value - allowed object is String

See Also:

getMimeType()

getFolderId

public int getFolderId()

 <?xml version="1.0" encoding="UTF-8"?><p xmlns="http://schema.webpdf.de/1.0/extraction/info" xmlns:xs="http://www.w3.org/2001/XMLSchema">The numeric ID of the folder containing the attachment.
                         (This is only relevant for PDF Collections/Portfolios - otherwise attachments may not be arranged in a folder tree.)
                     </p>
 

Returns:

possible object is Integer

setFolderId

public void setFolderId(Integer value)

Sets the value of the folderId property.

Parameters:

value - allowed object is Integer

See Also:

getFolderId()