| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final java.lang.String |
+ATTR_bgColour |
+"bgColour" |
+
+
+public static final java.lang.String |
+ATTR_bold |
+"bold" |
+
+
+public static final java.lang.String |
+ATTR_borderPresent |
+"borderPresent" |
+
+
+public static final java.lang.String |
+ATTR_caption |
+"caption" |
+
+
+public static final java.lang.String |
+ATTR_colour |
+"colour" |
+
+
+public static final java.lang.String |
+ATTR_colourDepth |
+"colourDepth" |
+
+
+public static final java.lang.String |
+ATTR_columns |
+"columns" |
+
+
+public static final java.lang.String |
+ATTR_comments |
+"comments" |
+
+
+public static final java.lang.String |
+ATTR_conf |
+"conf" |
+
+
+public static final java.lang.String |
+ATTR_custom |
+"custom" |
+
+
+public static final java.lang.String |
+ATTR_embText |
+"embText" |
+
+
+public static final java.lang.String |
+ATTR_filename |
+"filename" |
+
+
+public static final java.lang.String |
+ATTR_fontSize |
+"fontSize" |
+
+
+public static final java.lang.String |
+ATTR_id |
+"id" |
+
+
+public static final java.lang.String |
+ATTR_imageFilename |
+"imageFilename" |
+
+
+public static final java.lang.String |
+ATTR_imageHeight |
+"imageHeight" |
+
+
+public static final java.lang.String |
+ATTR_imageWidth |
+"imageWidth" |
+
+
+public static final java.lang.String |
+ATTR_indented |
+"indented" |
+
+
+public static final java.lang.String |
+ATTR_index |
+"index" |
+
+
+public static final java.lang.String |
+ATTR_italic |
+"italic" |
+
+
+public static final java.lang.String |
+ATTR_kerning |
+"kerning" |
+
+
+public static final java.lang.String |
+ATTR_language |
+"language" |
+
+
+public static final java.lang.String |
+ATTR_leading |
+"leading" |
+
+
+public static final java.lang.String |
+ATTR_letterSpaced |
+"letterSpaced" |
+
+
+public static final java.lang.String |
+ATTR_ligature |
+"ligature" |
+
+
+public static final java.lang.String |
+ATTR_lineColour |
+"lineColour" |
+
+
+public static final java.lang.String |
+ATTR_lineSeparators |
+"lineSeparators" |
+
+
+public static final java.lang.String |
+ATTR_numColours |
+"numColours" |
+
+
+public static final java.lang.String |
+ATTR_orientation |
+"orientation" |
+
+
+public static final java.lang.String |
+ATTR_pcGtsId |
+"pcGtsId" |
+
+
+public static final java.lang.String |
+ATTR_penColour |
+"penColour" |
+
+
+public static final java.lang.String |
+ATTR_points |
+"points" |
+
+
+public static final java.lang.String |
+ATTR_primaryLanguage |
+"primaryLanguage" |
+
+
+public static final java.lang.String |
+ATTR_primaryScript |
+"primaryScript" |
+
+
+public static final java.lang.String |
+ATTR_readingDirection |
+"readingDirection" |
+
+
+public static final java.lang.String |
+ATTR_readingOrientation |
+"readingOrientation" |
+
+
+public static final java.lang.String |
+ATTR_regionRef |
+"regionRef" |
+
+
+public static final java.lang.String |
+ATTR_reverseVideo |
+"reverseVideo" |
+
+
+public static final java.lang.String |
+ATTR_rows |
+"rows" |
+
+
+public static final java.lang.String |
+ATTR_secondaryLanguage |
+"secondaryLanguage" |
+
+
+public static final java.lang.String |
+ATTR_secondaryScript |
+"secondaryScript" |
+
+
+public static final java.lang.String |
+ATTR_smallCaps |
+"smallCaps" |
+
+
+public static final java.lang.String |
+ATTR_strikethrough |
+"strikethrough" |
+
+
+public static final java.lang.String |
+ATTR_subscript |
+"subscript" |
+
+
+public static final java.lang.String |
+ATTR_superscript |
+"superscript" |
+
+
+public static final java.lang.String |
+ATTR_symbol |
+"symbol" |
+
+
+public static final java.lang.String |
+ATTR_textColour |
+"textColour" |
+
+
+public static final java.lang.String |
+ATTR_type |
+"type" |
+
+
+public static final java.lang.String |
+ATTR_underlined |
+"underlined" |
+
+
+public static final java.lang.String |
+ATTR_x |
+"x" |
+
+
+public static final java.lang.String |
+ATTR_y |
+"y" |
+
+
+public static final java.lang.String |
+ATTR_zIndex |
+"zIndex" |
+
+
+public static final java.lang.String |
+ELEMENT_AdvertRegion |
+"AdvertRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_AlternativeImage |
+"AlternativeImage" |
+
+
+public static final java.lang.String |
+ELEMENT_Baseline |
+"Baseline" |
+
+
+public static final java.lang.String |
+ELEMENT_Border |
+"Border" |
+
+
+public static final java.lang.String |
+ELEMENT_ChartRegion |
+"ChartRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_ChemRegion |
+"ChemRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_Comments |
+"Comments" |
+
+
+public static final java.lang.String |
+ELEMENT_Coords |
+"Coords" |
+
+
+public static final java.lang.String |
+ELEMENT_Created |
+"Created" |
+
+
+public static final java.lang.String |
+ELEMENT_Creator |
+"Creator" |
+
+
+public static final java.lang.String |
+ELEMENT_FrameRegion |
+"FrameRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_Glyph |
+"Glyph" |
+
+
+public static final java.lang.String |
+ELEMENT_GraphicRegion |
+"GraphicRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_ImageRegion |
+"ImageRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_LastChange |
+"LastChange" |
+
+
+public static final java.lang.String |
+ELEMENT_Layer |
+"Layer" |
+
+
+public static final java.lang.String |
+ELEMENT_Layers |
+"Layers" |
+
+
+public static final java.lang.String |
+ELEMENT_LineDrawingRegion |
+"LineDrawingRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_MathsRegion |
+"MathsRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_Metadata |
+"Metadata" |
+
+
+public static final java.lang.String |
+ELEMENT_MusicRegion |
+"MusicRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_NoiseRegion |
+"NoiseRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_OrderedGroup |
+"OrderedGroup" |
+
+
+public static final java.lang.String |
+ELEMENT_OrderedGroupIndexed |
+"OrderedGroupIndexed" |
+
+
+public static final java.lang.String |
+ELEMENT_Page |
+"Page" |
+
+
+public static final java.lang.String |
+ELEMENT_PcGts |
+"PcGts" |
+
+
+public static final java.lang.String |
+ELEMENT_PlainText |
+"PlainText" |
+
+
+public static final java.lang.String |
+ELEMENT_Point |
+"Point" |
+
+
+public static final java.lang.String |
+ELEMENT_PrintSpace |
+"PrintSpace" |
+
+
+public static final java.lang.String |
+ELEMENT_ReadingOrder |
+"ReadingOrder" |
+
+
+public static final java.lang.String |
+ELEMENT_RegionRef |
+"RegionRef" |
+
+
+public static final java.lang.String |
+ELEMENT_RegionRefIndexed |
+"RegionRefIndexed" |
+
+
+public static final java.lang.String |
+ELEMENT_Relation |
+"Relation" |
+
+
+public static final java.lang.String |
+ELEMENT_Relations |
+"Relations" |
+
+
+public static final java.lang.String |
+ELEMENT_SeparatorRegion |
+"SeparatorRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_TableRegion |
+"TableRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_TextEquiv |
+"TextEquiv" |
+
+
+public static final java.lang.String |
+ELEMENT_TextLine |
+"TextLine" |
+
+
+public static final java.lang.String |
+ELEMENT_TextRegion |
+"TextRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_TextStyle |
+"TextStyle" |
+
+
+public static final java.lang.String |
+ELEMENT_Unicode |
+"Unicode" |
+
+
+public static final java.lang.String |
+ELEMENT_UnknownRegion |
+"UnknownRegion" |
+
+
+public static final java.lang.String |
+ELEMENT_UnorderedGroup |
+"UnorderedGroup" |
+
+
+public static final java.lang.String |
+ELEMENT_UnorderedGroupIndexed |
+"UnorderedGroupIndexed" |
+
+
+public static final java.lang.String |
+ELEMENT_Word |
+"Word" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+CONVERSION_ADD_REQUIRED_REGION |
+2 |
+
+
+public static final int |
+CONVERSION_GENERAL |
+0 |
+
+
+public static final int |
+CONVERSION_RESET_INVALID_ATTRIBUTE |
+1 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final java.lang.String |
+TEMP_ID_SUFFIX |
+"357564684568544579089" |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final java.lang.String |
+CAPTION |
+"caption" |
+
+
+public static final java.lang.String |
+CATCH_WORD |
+"catch-word" |
+
+
+public static final java.lang.String |
+CREDIT |
+"credit" |
+
+
+public static final java.lang.String |
+DROP_CAPITAL |
+"drop-capital" |
+
+
+public static final java.lang.String |
+ENDNOTE |
+"endnote" |
+
+
+public static final java.lang.String |
+FLOATING |
+"floating" |
+
+
+public static final java.lang.String |
+FOOTER |
+"footer" |
+
+
+public static final java.lang.String |
+FOOTNOTE |
+"footnote" |
+
+
+public static final java.lang.String |
+FOOTNOTE_CONTINUED |
+"footnote-continued" |
+
+
+public static final java.lang.String |
+HEADER |
+"header" |
+
+
+public static final java.lang.String |
+HEADING |
+"heading" |
+
+
+public static final java.lang.String |
+MARGINALIA |
+"marginalia" |
+
+
+public static final java.lang.String |
+OTHER |
+"other" |
+
+
+public static final java.lang.String |
+PAGE_NUMBER |
+"page-number" |
+
+
+public static final java.lang.String |
+PARAGRAPH |
+"paragraph" |
+
+
+public static final java.lang.String |
+SIGNATURE_MARK |
+"signature-mark" |
+
+
+public static final java.lang.String |
+TOC_ENTRY |
+"TOC-entry" |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/deprecated-list.html b/java/PrimaDla/apidoc/deprecated-list.html new file mode 100644 index 00000000..b78bc2c4 --- /dev/null +++ b/java/PrimaDla/apidoc/deprecated-list.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/help-doc.html b/java/PrimaDla/apidoc/help-doc.html new file mode 100644 index 00000000..48766f5e --- /dev/null +++ b/java/PrimaDla/apidoc/help-doc.html @@ -0,0 +1,221 @@ + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/index-all.html b/java/PrimaDla/apidoc/index-all.html new file mode 100644 index 00000000..06cc6090 --- /dev/null +++ b/java/PrimaDla/apidoc/index-all.html @@ -0,0 +1,2702 @@ + + + + + +CONVERSION_... constants)null for no restriction)null if it is a root groupnull if it has no parentCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/index.html b/java/PrimaDla/apidoc/index.html new file mode 100644 index 00000000..91f355d9 --- /dev/null +++ b/java/PrimaDla/apidoc/index.html @@ -0,0 +1,67 @@ + + + + + +public class MetaData
+extends java.lang.Object
+implements java.io.Serializable
+| Modifier and Type | +Field and Description | +
|---|---|
static java.text.DateFormat |
+DATE_FORMAT |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getComments()
+Returns comments (generic)
+ |
+
java.util.Date |
+getCreationTime()
+Returns the creation date/time
+ |
+
java.lang.String |
+getCreator()
+Returns the creating person, institution, and/or tool
+ |
+
java.lang.String |
+getFormattedCreationTime()
+Returns the creation date/time
+ |
+
java.lang.String |
+getFormattedLastModificationTime()
+Returns the modification date/time
+ |
+
java.util.Date |
+getLastModificationTime()
+Returns the modification date/time
+ |
+
void |
+setComments(java.lang.String comments)
+Sets generic comments
+ |
+
void |
+setCreationTime(java.util.Date d)
+Sets the creation date/time
+ |
+
void |
+setCreator(java.lang.String creator)
+Sets the creating person, institution, and/or tool
+ |
+
void |
+setLastModifiedTime(java.util.Date d)
+Sets the modification date/time
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic java.lang.String getCreator()+
public void setCreator(java.lang.String creator)+
creator - Creator descriptionpublic java.lang.String getComments()+
public void setComments(java.lang.String comments)+
comments - Comments textpublic java.lang.String getFormattedCreationTime()+
DATE_FORMAT constantpublic java.util.Date getCreationTime()+
public java.lang.String getFormattedLastModificationTime()+
DATE_FORMAT constantpublic java.util.Date getLastModificationTime()+
public void setCreationTime(java.util.Date d)+
d - Date objectpublic void setLastModifiedTime(java.util.Date d)+
d - Date objectCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.AlternativeImage.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.AlternativeImage.html new file mode 100644 index 00000000..aac0784e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.AlternativeImage.html @@ -0,0 +1,303 @@ + + + + + +public static final class Page.AlternativeImage
+extends java.lang.Object
+| Constructor and Description | +
|---|
Page.AlternativeImage(java.lang.String filename) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getComments() |
+
java.lang.String |
+getFilename() |
+
void |
+setComments(java.lang.String comments) |
+
void |
+setFilename(java.lang.String filename) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic Page.AlternativeImage(java.lang.String filename)+
public java.lang.String getFilename()+
public void setFilename(java.lang.String filename)+
public java.lang.String getComments()+
public void setComments(java.lang.String comments)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.MeasurementUnit.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.MeasurementUnit.html new file mode 100644 index 00000000..ccab2d54 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.MeasurementUnit.html @@ -0,0 +1,364 @@ + + + + + +public static class Page.MeasurementUnit
+extends java.lang.Object
+XmlInputOutput.postProcessPage(...)
+ to scale all coordinates using the image information.| Modifier and Type | +Field and Description | +
|---|---|
static Page.MeasurementUnit |
+INCH_BY_1200
+1200th of an inch
+ |
+
static Page.MeasurementUnit |
+MM_BY_10
+One tenth of a mm
+ |
+
static Page.MeasurementUnit |
+PIXEL |
+
| Constructor and Description | +
|---|
Page.MeasurementUnit(java.lang.String name,
+ double discreteValuesPerInch) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(java.lang.Object other) |
+
double |
+getDiscreteValuesPerInch() |
+
java.lang.String |
+getName() |
+
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final Page.MeasurementUnit PIXEL+
public static final Page.MeasurementUnit MM_BY_10+
public static final Page.MeasurementUnit INCH_BY_1200+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.html new file mode 100644 index 00000000..774fc012 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/Page.html @@ -0,0 +1,530 @@ + + + + + +public class Page +extends java.lang.Object +implements AttributeContainer+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+Page.AlternativeImage
+Alternative document page image (e.g.
+ |
+
static class |
+Page.MeasurementUnit
+Measurement unit for coordinates.
++ Introduced to support ALTO XML files. |
+
| Constructor and Description | +
|---|
Page()
+Constructor using the default page format.
+ |
+
Page(org.primaresearch.io.FormatModel formatModel)
+Constructor using dynamic page format.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<Page.AlternativeImage> |
+getAlternativeImages()
+Returns a list of alternative images that are associated with this page (e.g.
+ |
+
org.primaresearch.shared.variable.VariableMap |
+getAttributes()
+Returns the attributes of the object.
+ |
+
org.primaresearch.io.FormatVersion |
+getFormatVersion()
+Returns the version of the page format.
+ |
+
org.primaresearch.ident.Id |
+getGtsId()
+Returns the ground truth and storage ID of this page
+ |
+
java.lang.String |
+getImageFilename()
+Returns the main image file that is associated with this page.
+ |
+
PageLayout |
+getLayout()
+Returns the page layout
+ |
+
Page.MeasurementUnit |
+getMeasurementUnit()
+Returns the measurement unit for coordinates
+ |
+
MetaData |
+getMetaData()
+Returns the page metadata
+ |
+
java.util.List<ConversionMessage> |
+setFormatVersion(org.primaresearch.io.FormatModel formatModel)
+Converts the page to the specified format.
+ |
+
void |
+setGtsId(org.primaresearch.ident.Id gtsId)
+Sets the ground truth and storage ID of this page
+ |
+
void |
+setGtsId(java.lang.String gtsId)
+Sets the ground truth and storage ID of this page
+ |
+
void |
+setImageFilename(java.lang.String imageFilename)
+Sets the main image file that is associated with this page.
+ |
+
void |
+setMeasurementUnit(Page.MeasurementUnit unit)
+Sets the measurement unit for coordinates
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic Page()+
public Page(org.primaresearch.io.FormatModel formatModel)+
formatModel - Model for dynamic formatpublic org.primaresearch.io.FormatVersion getFormatVersion()+
public java.util.List<ConversionMessage> setFormatVersion(org.primaresearch.io.FormatModel formatModel)+
public java.lang.String getImageFilename()+
public void setImageFilename(java.lang.String imageFilename)+
imageFilename - Filename (without path)public PageLayout getLayout()+
public MetaData getMetaData()+
public org.primaresearch.ident.Id getGtsId()+
public void setGtsId(org.primaresearch.ident.Id gtsId) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
gtsId - ID objectorg.primaresearch.ident.IdRegister.InvalidIdException - ID is being used already (must be unique)public void setGtsId(java.lang.String gtsId) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
gtsId - ID textorg.primaresearch.ident.IdRegister.InvalidIdException - ID is being used already (must be unique) or the format is invalidpublic org.primaresearch.shared.variable.VariableMap getAttributes()+
AttributeContainergetAttributes in interface AttributeContainerpublic java.util.List<Page.AlternativeImage> getAlternativeImages()+
public Page.MeasurementUnit getMeasurementUnit()+
public void setMeasurementUnit(Page.MeasurementUnit unit)+
unit - Unit objectCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/MetaData.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/MetaData.html new file mode 100644 index 00000000..a383b411 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/MetaData.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
MetaData |
+Page.getMetaData()
+Returns the page metadata
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.AlternativeImage.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.AlternativeImage.html new file mode 100644 index 00000000..f2378b93 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.AlternativeImage.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<Page.AlternativeImage> |
+Page.getAlternativeImages()
+Returns a list of alternative images that are associated with this page (e.g.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.MeasurementUnit.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.MeasurementUnit.html new file mode 100644 index 00000000..a2e7a3eb --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.MeasurementUnit.html @@ -0,0 +1,198 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static Page.MeasurementUnit |
+Page.MeasurementUnit.INCH_BY_1200
+1200th of an inch
+ |
+
static Page.MeasurementUnit |
+Page.MeasurementUnit.MM_BY_10
+One tenth of a mm
+ |
+
static Page.MeasurementUnit |
+Page.MeasurementUnit.PIXEL |
+
| Modifier and Type | +Method and Description | +
|---|---|
Page.MeasurementUnit |
+Page.getMeasurementUnit()
+Returns the measurement unit for coordinates
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Page.setMeasurementUnit(Page.MeasurementUnit unit)
+Sets the measurement unit for coordinates
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.html new file mode 100644 index 00000000..320a1785 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/class-use/Page.html @@ -0,0 +1,375 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io | ++ |
| org.primaresearch.dla.page.io.xml | ++ |
| org.primaresearch.dla.page.io.xml.sax | ++ |
| org.primaresearch.dla.page.layout.converter | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Page |
+PageReader.read(InputSource source)
+Reads a PAGE input source and returns a Page object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+PageWriter.validate(Page page)
+Validates the given page object against the format it is set to.
+ |
+
boolean |
+PageWriter.write(Page page,
+ OutputTarget target)
+Writes the given Page object to an output target.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Page |
+XmlPageReader.read(InputSource source)
+Reads a PAGE XML file and returns a Page object.
+ |
+
static Page |
+PageXmlInputOutput.readPage(java.lang.String filePath)
+Creates a page object from the given XML file.
+ |
+
static Page |
+PageXmlInputOutput.readPage(java.net.URL url)
+Creates a page object from the given XML file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+PageXmlInputOutput.postProcessPage(Page page,
+ int imageWidth,
+ int imageHeight,
+ double dpiHor,
+ double dpiVert)
+Post-processes the given page object using the specified image dimension and resolution.
++ This could include scaling all coordinates if they are not measured in pixel. |
+
boolean |
+XmlPageWriter_2013_07_15.validate(Page page)
+Validates the given Page object against the XML schema.
+ |
+
boolean |
+XmlPageWriter_2010_03_19.validate(Page page)
+Validates the given Page object against the XML schema.
+ |
+
boolean |
+XmlPageWriter_2013_07_15.write(Page page,
+ OutputTarget target)
+Writes the given Page object to an XML file.
+ |
+
boolean |
+XmlPageWriter_2010_03_19.write(Page page,
+ OutputTarget target)
+Writes the given Page object to an XML file.
+ |
+
static boolean |
+PageXmlInputOutput.writePage(Page page,
+ java.lang.String filePath)
+Saves the given document page to an XML file at the specified
+ location, using the latest PAGE XML format or the format the
+ page object has been loaded with.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Page |
+SaxPageHandler_Hocr.getPageObject() |
+
Page |
+SaxPageHandler_Alto_2_1.getPageObject() |
+
Page |
+SaxPageHandler_AbbyyFineReader10.getPageObject() |
+
Page |
+SaxPageHandler_2013_07_15.getPageObject() |
+
Page |
+SaxPageHandler_2010_03_19.getPageObject() |
+
Page |
+SaxPageHandlerLegacy.getPageObject() |
+
abstract Page |
+SaxPageHandler.getPageObject()
+Returns the page object that has been created from XML
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static java.util.List<ConversionMessage> |
+ConverterHub.checkForCompliance(Page page,
+ org.primaresearch.io.FormatVersion targetVersion)
+Checks if the given page (layout) complies with specified target format.
+ |
+
static java.util.List<ConversionMessage> |
+ConverterHub.convert(Page page,
+ org.primaresearch.io.FormatModel targetModel)
+Converts the given page (layout) to the specified target format (might change attributes, attribute values and attribute constraints).
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ContentObjectProcessor.run(Page page)
+Run the processor.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/FileInput.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/FileInput.html new file mode 100644 index 00000000..5ce42383 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/FileInput.html @@ -0,0 +1,265 @@ + + + + + +public class FileInput +extends java.lang.Object +implements InputSource+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/FileTarget.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/FileTarget.html new file mode 100644 index 00000000..363166fd --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/FileTarget.html @@ -0,0 +1,265 @@ + + + + + +public class FileTarget +extends java.lang.Object +implements OutputTarget+
| Constructor and Description | +
|---|
FileTarget(java.io.File file) |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/InputSource.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/InputSource.html new file mode 100644 index 00000000..a7463bae --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/InputSource.html @@ -0,0 +1,166 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/OutputTarget.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/OutputTarget.html new file mode 100644 index 00000000..acedb372 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/OutputTarget.html @@ -0,0 +1,166 @@ + + + + + +public interface OutputTarget
+Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/PageReader.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/PageReader.html new file mode 100644 index 00000000..5a388d23 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/PageReader.html @@ -0,0 +1,223 @@ + + + + + +public interface PageReader
+| Modifier and Type | +Method and Description | +
|---|---|
Page |
+read(InputSource source)
+Reads a PAGE input source and returns a Page object.
+ |
+
Page read(InputSource source) + throws org.primaresearch.io.UnsupportedFormatVersionException+
source - Input source of some kind (e.g. FileInput).org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionExceptionorg.primaresearch.io.UnsupportedFormatVersionExceptionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/PageWriter.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/PageWriter.html new file mode 100644 index 00000000..b7d68c15 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/PageWriter.html @@ -0,0 +1,247 @@ + + + + + +public interface PageWriter
+boolean write(Page page, + OutputTarget target) + throws org.primaresearch.io.UnsupportedFormatVersionException+
org.primaresearch.io.UnsupportedFormatVersionExceptionboolean validate(Page page) + throws org.primaresearch.io.UnsupportedFormatVersionException+
org.primaresearch.io.UnsupportedFormatVersionExceptionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/UrlInput.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/UrlInput.html new file mode 100644 index 00000000..7e5e64c7 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/UrlInput.html @@ -0,0 +1,265 @@ + + + + + +public class UrlInput +extends java.lang.Object +implements InputSource+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/FileInput.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/FileInput.html new file mode 100644 index 00000000..10e25441 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/FileInput.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/FileTarget.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/FileTarget.html new file mode 100644 index 00000000..172709e1 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/FileTarget.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/InputSource.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/InputSource.html new file mode 100644 index 00000000..f5d9c1be --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/InputSource.html @@ -0,0 +1,207 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io | ++ |
| org.primaresearch.dla.page.io.xml | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FileInput
+Input source implementation for files
+ |
+
class |
+UrlInput
+InputSouce implementation for URLs.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Page |
+PageReader.read(InputSource source)
+Reads a PAGE input source and returns a Page object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Page |
+XmlPageReader.read(InputSource source)
+Reads a PAGE XML file and returns a Page object.
+ |
+
java.util.List<java.lang.String> |
+MetsMultiPageReader.read(InputSource source) |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/OutputTarget.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/OutputTarget.html new file mode 100644 index 00000000..64e3b3ea --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/OutputTarget.html @@ -0,0 +1,221 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io | ++ |
| org.primaresearch.dla.page.io.xml | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FileTarget
+OutputTarget implementation for files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+PageWriter.write(Page page,
+ OutputTarget target)
+Writes the given Page object to an output target.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+StreamTarget
+Generic output target can be any type of stream.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+XmlPageWriter_2013_07_15.write(Page page,
+ OutputTarget target)
+Writes the given Page object to an XML file.
+ |
+
boolean |
+XmlPageWriter_2010_03_19.write(Page page,
+ OutputTarget target)
+Writes the given Page object to an XML file.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/PageReader.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/PageReader.html new file mode 100644 index 00000000..2951b105 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/PageReader.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+XmlPageReader
+Page reader implementation for XML files (supports validation against schema).
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/PageWriter.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/PageWriter.html new file mode 100644 index 00000000..237a9766 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/PageWriter.html @@ -0,0 +1,179 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+XmlPageWriter
+Interface for page writers producing XML.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+XmlPageWriter_2010_03_19
+Page writer implementation for XML files.
+ |
+
class |
+XmlPageWriter_2013_07_15
+Page writer implementation for XML files.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/UrlInput.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/UrlInput.html new file mode 100644 index 00000000..101b8d32 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/class-use/UrlInput.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-frame.html new file mode 100644 index 00000000..2b00c354 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-frame.html @@ -0,0 +1,28 @@ + + + + + +| Interface | +Description | +
|---|---|
| InputSource | +
+ Interface for input sources such as files or URLs.
+ |
+
| OutputTarget | +
+ Interface for output targets (e.g.
+ |
+
| PageReader | +
+ Reader interface for PAGE.
+ |
+
| PageWriter | +
+ Interface for writing PAGE.
+ |
+
| Class | +Description | +
|---|---|
| FileInput | +
+ Input source implementation for files
+ |
+
| FileTarget | +
+ OutputTarget implementation for files.
+ |
+
| UrlInput | +
+ InputSouce implementation for URLs.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-tree.html new file mode 100644 index 00000000..78e02558 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-tree.html @@ -0,0 +1,138 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-use.html new file mode 100644 index 00000000..a2cb0178 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/package-use.html @@ -0,0 +1,192 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io | ++ |
| org.primaresearch.dla.page.io.xml | ++ |
| Class and Description | +
|---|
| InputSource
+ Interface for input sources such as files or URLs.
+ |
+
| OutputTarget
+ Interface for output targets (e.g.
+ |
+
| Class and Description | +
|---|
| InputSource
+ Interface for input sources such as files or URLs.
+ |
+
| OutputTarget
+ Interface for output targets (e.g.
+ |
+
| PageReader
+ Reader interface for PAGE.
+ |
+
| PageWriter
+ Interface for writing PAGE.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/DefaultXmlNames.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/DefaultXmlNames.html new file mode 100644 index 00000000..1d33d742 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/DefaultXmlNames.html @@ -0,0 +1,1650 @@ + + + + + +public class DefaultXmlNames +extends java.lang.Object +implements XmlNameProvider+
| Modifier and Type | +Field and Description | +
|---|---|
static java.lang.String |
+ATTR_bgColour |
+
static java.lang.String |
+ATTR_bold |
+
static java.lang.String |
+ATTR_borderPresent |
+
static java.lang.String |
+ATTR_caption |
+
static java.lang.String |
+ATTR_colour |
+
static java.lang.String |
+ATTR_colourDepth |
+
static java.lang.String |
+ATTR_columns |
+
static java.lang.String |
+ATTR_comments |
+
static java.lang.String |
+ATTR_conf |
+
static java.lang.String |
+ATTR_custom |
+
static java.lang.String |
+ATTR_embText |
+
static java.lang.String |
+ATTR_filename |
+
static java.lang.String |
+ATTR_fontSize |
+
static java.lang.String |
+ATTR_id |
+
static java.lang.String |
+ATTR_imageFilename |
+
static java.lang.String |
+ATTR_imageHeight |
+
static java.lang.String |
+ATTR_imageWidth |
+
static java.lang.String |
+ATTR_indented |
+
static java.lang.String |
+ATTR_index |
+
static java.lang.String |
+ATTR_italic |
+
static java.lang.String |
+ATTR_kerning |
+
static java.lang.String |
+ATTR_language |
+
static java.lang.String |
+ATTR_leading |
+
static java.lang.String |
+ATTR_letterSpaced |
+
static java.lang.String |
+ATTR_ligature |
+
static java.lang.String |
+ATTR_lineColour |
+
static java.lang.String |
+ATTR_lineSeparators |
+
static java.lang.String |
+ATTR_numColours |
+
static java.lang.String |
+ATTR_orientation |
+
static java.lang.String |
+ATTR_pcGtsId |
+
static java.lang.String |
+ATTR_penColour |
+
static java.lang.String |
+ATTR_points |
+
static java.lang.String |
+ATTR_primaryLanguage |
+
static java.lang.String |
+ATTR_primaryScript |
+
static java.lang.String |
+ATTR_readingDirection |
+
static java.lang.String |
+ATTR_readingOrientation |
+
static java.lang.String |
+ATTR_regionRef |
+
static java.lang.String |
+ATTR_reverseVideo |
+
static java.lang.String |
+ATTR_rows |
+
static java.lang.String |
+ATTR_secondaryLanguage |
+
static java.lang.String |
+ATTR_secondaryScript |
+
static java.lang.String |
+ATTR_smallCaps |
+
static java.lang.String |
+ATTR_strikethrough |
+
static java.lang.String |
+ATTR_subscript |
+
static java.lang.String |
+ATTR_superscript |
+
static java.lang.String |
+ATTR_symbol |
+
static java.lang.String |
+ATTR_textColour |
+
static java.lang.String |
+ATTR_type |
+
static java.lang.String |
+ATTR_underlined |
+
static java.lang.String |
+ATTR_x |
+
static java.lang.String |
+ATTR_y |
+
static java.lang.String |
+ATTR_zIndex |
+
static java.lang.String |
+ELEMENT_AdvertRegion |
+
static java.lang.String |
+ELEMENT_AlternativeImage |
+
static java.lang.String |
+ELEMENT_Baseline |
+
static java.lang.String |
+ELEMENT_Border |
+
static java.lang.String |
+ELEMENT_ChartRegion |
+
static java.lang.String |
+ELEMENT_ChemRegion |
+
static java.lang.String |
+ELEMENT_Comments |
+
static java.lang.String |
+ELEMENT_Coords |
+
static java.lang.String |
+ELEMENT_Created |
+
static java.lang.String |
+ELEMENT_Creator |
+
static java.lang.String |
+ELEMENT_FrameRegion |
+
static java.lang.String |
+ELEMENT_Glyph |
+
static java.lang.String |
+ELEMENT_GraphicRegion |
+
static java.lang.String |
+ELEMENT_ImageRegion |
+
static java.lang.String |
+ELEMENT_LastChange |
+
static java.lang.String |
+ELEMENT_Layer |
+
static java.lang.String |
+ELEMENT_Layers |
+
static java.lang.String |
+ELEMENT_LineDrawingRegion |
+
static java.lang.String |
+ELEMENT_MathsRegion |
+
static java.lang.String |
+ELEMENT_Metadata |
+
static java.lang.String |
+ELEMENT_MusicRegion |
+
static java.lang.String |
+ELEMENT_NoiseRegion |
+
static java.lang.String |
+ELEMENT_OrderedGroup |
+
static java.lang.String |
+ELEMENT_OrderedGroupIndexed |
+
static java.lang.String |
+ELEMENT_Page |
+
static java.lang.String |
+ELEMENT_PcGts |
+
static java.lang.String |
+ELEMENT_PlainText |
+
static java.lang.String |
+ELEMENT_Point |
+
static java.lang.String |
+ELEMENT_PrintSpace |
+
static java.lang.String |
+ELEMENT_ReadingOrder |
+
static java.lang.String |
+ELEMENT_RegionRef |
+
static java.lang.String |
+ELEMENT_RegionRefIndexed |
+
static java.lang.String |
+ELEMENT_Relation |
+
static java.lang.String |
+ELEMENT_Relations |
+
static java.lang.String |
+ELEMENT_SeparatorRegion |
+
static java.lang.String |
+ELEMENT_TableRegion |
+
static java.lang.String |
+ELEMENT_TextEquiv |
+
static java.lang.String |
+ELEMENT_TextLine |
+
static java.lang.String |
+ELEMENT_TextRegion |
+
static java.lang.String |
+ELEMENT_TextStyle |
+
static java.lang.String |
+ELEMENT_Unicode |
+
static java.lang.String |
+ELEMENT_UnknownRegion |
+
static java.lang.String |
+ELEMENT_UnorderedGroup |
+
static java.lang.String |
+ELEMENT_UnorderedGroupIndexed |
+
static java.lang.String |
+ELEMENT_Word |
+
| Constructor and Description | +
|---|
DefaultXmlNames() |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getXmlName(ContentType type) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final java.lang.String ELEMENT_PcGts+
public static final java.lang.String ELEMENT_Page+
public static final java.lang.String ELEMENT_TextRegion+
public static final java.lang.String ELEMENT_ImageRegion+
public static final java.lang.String ELEMENT_LineDrawingRegion+
public static final java.lang.String ELEMENT_GraphicRegion+
public static final java.lang.String ELEMENT_TableRegion+
public static final java.lang.String ELEMENT_ChartRegion+
public static final java.lang.String ELEMENT_SeparatorRegion+
public static final java.lang.String ELEMENT_MathsRegion+
public static final java.lang.String ELEMENT_NoiseRegion+
public static final java.lang.String ELEMENT_FrameRegion+
public static final java.lang.String ELEMENT_UnknownRegion+
public static final java.lang.String ELEMENT_AdvertRegion+
public static final java.lang.String ELEMENT_ChemRegion+
public static final java.lang.String ELEMENT_MusicRegion+
public static final java.lang.String ELEMENT_Border+
public static final java.lang.String ELEMENT_ReadingOrder+
public static final java.lang.String ELEMENT_RegionRef+
public static final java.lang.String ELEMENT_UnorderedGroup+
public static final java.lang.String ELEMENT_OrderedGroup+
public static final java.lang.String ELEMENT_RegionRefIndexed+
public static final java.lang.String ELEMENT_UnorderedGroupIndexed+
public static final java.lang.String ELEMENT_OrderedGroupIndexed+
public static final java.lang.String ELEMENT_Layers+
public static final java.lang.String ELEMENT_Layer+
public static final java.lang.String ELEMENT_PrintSpace+
public static final java.lang.String ELEMENT_Coords+
public static final java.lang.String ELEMENT_Point+
public static final java.lang.String ELEMENT_TextEquiv+
public static final java.lang.String ELEMENT_TextLine+
public static final java.lang.String ELEMENT_Word+
public static final java.lang.String ELEMENT_Glyph+
public static final java.lang.String ELEMENT_PlainText+
public static final java.lang.String ELEMENT_Unicode+
public static final java.lang.String ELEMENT_Baseline+
public static final java.lang.String ELEMENT_Metadata+
public static final java.lang.String ELEMENT_Creator+
public static final java.lang.String ELEMENT_Created+
public static final java.lang.String ELEMENT_LastChange+
public static final java.lang.String ELEMENT_Comments+
public static final java.lang.String ELEMENT_AlternativeImage+
public static final java.lang.String ELEMENT_Relations+
public static final java.lang.String ELEMENT_Relation+
public static final java.lang.String ELEMENT_TextStyle+
public static final java.lang.String ATTR_pcGtsId+
public static final java.lang.String ATTR_imageFilename+
public static final java.lang.String ATTR_imageWidth+
public static final java.lang.String ATTR_imageHeight+
public static final java.lang.String ATTR_id+
public static final java.lang.String ATTR_x+
public static final java.lang.String ATTR_y+
public static final java.lang.String ATTR_orientation+
public static final java.lang.String ATTR_readingOrientation+
public static final java.lang.String ATTR_readingDirection+
public static final java.lang.String ATTR_leading+
public static final java.lang.String ATTR_kerning+
public static final java.lang.String ATTR_fontSize+
public static final java.lang.String ATTR_type+
public static final java.lang.String ATTR_textColour+
public static final java.lang.String ATTR_bgColour+
public static final java.lang.String ATTR_reverseVideo+
public static final java.lang.String ATTR_indented+
public static final java.lang.String ATTR_primaryLanguage+
public static final java.lang.String ATTR_secondaryLanguage+
public static final java.lang.String ATTR_language+
public static final java.lang.String ATTR_primaryScript+
public static final java.lang.String ATTR_secondaryScript+
public static final java.lang.String ATTR_colourDepth+
public static final java.lang.String ATTR_embText+
public static final java.lang.String ATTR_penColour+
public static final java.lang.String ATTR_numColours+
public static final java.lang.String ATTR_rows+
public static final java.lang.String ATTR_columns+
public static final java.lang.String ATTR_lineColour+
public static final java.lang.String ATTR_lineSeparators+
public static final java.lang.String ATTR_colour+
public static final java.lang.String ATTR_borderPresent+
public static final java.lang.String ATTR_symbol+
public static final java.lang.String ATTR_ligature+
public static final java.lang.String ATTR_regionRef+
public static final java.lang.String ATTR_index+
public static final java.lang.String ATTR_zIndex+
public static final java.lang.String ATTR_points+
public static final java.lang.String ATTR_caption+
public static final java.lang.String ATTR_conf+
public static final java.lang.String ATTR_custom+
public static final java.lang.String ATTR_comments+
public static final java.lang.String ATTR_filename+
public static final java.lang.String ATTR_bold+
public static final java.lang.String ATTR_italic+
public static final java.lang.String ATTR_underlined+
public static final java.lang.String ATTR_strikethrough+
public static final java.lang.String ATTR_subscript+
public static final java.lang.String ATTR_superscript+
public static final java.lang.String ATTR_smallCaps+
public static final java.lang.String ATTR_letterSpaced+
public java.lang.String getXmlName(ContentType type)+
getXmlName in interface XmlNameProviderCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/MetsMultiPageReader.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/MetsMultiPageReader.html new file mode 100644 index 00000000..e7cace51 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/MetsMultiPageReader.html @@ -0,0 +1,260 @@ + + + + + +public class MetsMultiPageReader
+extends java.lang.Object
+| Constructor and Description | +
|---|
MetsMultiPageReader() |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<java.lang.String> |
+read(InputSource source) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic java.util.List<java.lang.String> read(InputSource source)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageErrorHandler.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageErrorHandler.html new file mode 100644 index 00000000..a7b666ab --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageErrorHandler.html @@ -0,0 +1,377 @@ + + + + + +public class PageErrorHandler
+extends java.lang.Object
+implements org.xml.sax.ErrorHandler
+| Constructor and Description | +
|---|
PageErrorHandler() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+error(org.xml.sax.SAXParseException exc) |
+
void |
+fatalError(org.xml.sax.SAXParseException exc) |
+
java.util.List<org.primaresearch.io.xml.IOError> |
+getErrors()
+Returns all registered errors
+ |
+
java.util.List<org.primaresearch.io.xml.IOError> |
+getWarnings()
+Returns all registered warnings
+ |
+
boolean |
+hasErrors()
+Checks if there were errors
+ |
+
boolean |
+hasWarnings()
+Checks if there were warnings
+ |
+
void |
+warning(org.xml.sax.SAXParseException exc) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void error(org.xml.sax.SAXParseException exc) + throws org.xml.sax.SAXException+
error in interface org.xml.sax.ErrorHandlerorg.xml.sax.SAXExceptionpublic void fatalError(org.xml.sax.SAXParseException exc) + throws org.xml.sax.SAXException+
fatalError in interface org.xml.sax.ErrorHandlerorg.xml.sax.SAXExceptionpublic void warning(org.xml.sax.SAXParseException exc) + throws org.xml.sax.SAXException+
warning in interface org.xml.sax.ErrorHandlerorg.xml.sax.SAXExceptionpublic boolean hasErrors()+
true if errors were registeredpublic boolean hasWarnings()+
true if warnings were registeredpublic java.util.List<org.primaresearch.io.xml.IOError> getErrors()+
public java.util.List<org.primaresearch.io.xml.IOError> getWarnings()+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageXmlInputOutput.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageXmlInputOutput.html new file mode 100644 index 00000000..53f4bea7 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageXmlInputOutput.html @@ -0,0 +1,486 @@ + + + + + +public class PageXmlInputOutput
+extends java.lang.Object
+implements org.primaresearch.io.FormatModelSource
+| Modifier and Type | +Method and Description | +
|---|---|
org.primaresearch.io.FormatModel |
+getFormatModel(org.primaresearch.io.FormatVersion version) |
+
static PageXmlInputOutput |
+getInstance()
+Returns the instance of the singleton.
+ |
+
static org.primaresearch.io.xml.SchemaModelParser |
+getLatestSchemaModel()
+Returns the model of the latest XML schema.
+ |
+
static XmlPageReader |
+getReader()
+Creates and returns an XML reader for PAGE.
+ |
+
static org.primaresearch.io.xml.SchemaModelParser |
+getSchemaModel(org.primaresearch.io.xml.XmlFormatVersion version)
+Returns the model of the latest XML schema.
+ |
+
static XmlPageWriter |
+getWriter(org.primaresearch.io.xml.XmlFormatVersion schemaVersion)
+Creates and returns an XML writer for PAGE using the specified schema version.
+ |
+
static XmlPageWriter |
+getWriterForLastestXmlFormat()
+Creates and returns an XML writer for PAGE using the latest schema version.
+ |
+
static void |
+postProcessPage(Page page,
+ int imageWidth,
+ int imageHeight,
+ double dpiHor,
+ double dpiVert)
+Post-processes the given page object using the specified image dimension and resolution.
++ This could include scaling all coordinates if they are not measured in pixel. |
+
static Page |
+readPage(java.lang.String filePath)
+Creates a page object from the given XML file.
+ |
+
static Page |
+readPage(java.net.URL url)
+Creates a page object from the given XML file.
+ |
+
static void |
+setAdditionalSchemaLocation(java.lang.String rootFolder)
+Sets the location of additional schema files and assumes the default schema file name 'pagecontent.xsd'.
+ |
+
static void |
+setAdditionalSchemaLocation(java.lang.String rootFolder,
+ java.lang.String schemaFilename)
+Sets the location of additional schema files and searches for schemas having the specified name.
+ |
+
static boolean |
+writePage(Page page,
+ java.lang.String filePath)
+Saves the given document page to an XML file at the specified
+ location, using the latest PAGE XML format or the format the
+ page object has been loaded with.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static PageXmlInputOutput getInstance()+
public static void setAdditionalSchemaLocation(java.lang.String rootFolder) + throws org.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasException+
rootFolder - Root of the schema folder structure containing the schema files.org.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasException - No schemas found at the given locationpublic static void setAdditionalSchemaLocation(java.lang.String rootFolder, + java.lang.String schemaFilename) + throws org.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasException+
rootFolder - Root of the schema folder structure containing the schema filesschemaFilename - Usually a filename with extension .xsdorg.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasException - No schemas found at the given locationpublic static XmlPageWriter getWriterForLastestXmlFormat() + throws org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException+
org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException - Schema file could not be found.public static XmlPageWriter getWriter(org.primaresearch.io.xml.XmlFormatVersion schemaVersion) + throws org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException+
org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException - The schema file could not be found.public static boolean writePage(Page page, + java.lang.String filePath) + throws org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException+
page - Page objectfilePath - Target fileorg.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException - Schema file could not be found.public static XmlPageReader getReader()+
public static Page readPage(java.lang.String filePath) + throws org.primaresearch.io.UnsupportedFormatVersionException+
filePath - Path to PAGE XML file.org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException - Schema file not foundorg.primaresearch.io.UnsupportedFormatVersionExceptionpublic static Page readPage(java.net.URL url) + throws org.primaresearch.io.UnsupportedFormatVersionException+
url - URL of PAGE XML file.org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException - Schema file not foundorg.primaresearch.io.UnsupportedFormatVersionExceptionpublic static org.primaresearch.io.xml.SchemaModelParser getLatestSchemaModel()+
public static org.primaresearch.io.xml.SchemaModelParser getSchemaModel(org.primaresearch.io.xml.XmlFormatVersion version)+
public org.primaresearch.io.FormatModel getFormatModel(org.primaresearch.io.FormatVersion version) + throws org.primaresearch.io.UnsupportedFormatVersionException+
getFormatModel in interface org.primaresearch.io.FormatModelSourceorg.primaresearch.io.UnsupportedFormatVersionExceptionpublic static void postProcessPage(Page page, + int imageWidth, + int imageHeight, + double dpiHor, + double dpiVert)+
page - Page object to post-processimageWidth - Width of the document imageimageHeight - Height of the document imagedpiHor - X resolution of the document imagedpiVert - Y resolution of the document imageCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageXmlModelAndValidatorProvider.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageXmlModelAndValidatorProvider.html new file mode 100644 index 00000000..4e1d08b5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/PageXmlModelAndValidatorProvider.html @@ -0,0 +1,337 @@ + + + + + +public class PageXmlModelAndValidatorProvider
+extends org.primaresearch.io.xml.XmlModelAndValidatorProvider
+org.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasException, org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException| Constructor and Description | +
|---|
PageXmlModelAndValidatorProvider()
+Constructor for default schemas only
+ |
+
PageXmlModelAndValidatorProvider(java.lang.String schemaRootFolder,
+ java.lang.String schemaFilename)
+Constructor for additional schema retrieval from a folder structure.
++ + Example: + -schema + -2010-01-12 + -pagecontent.xsd + -2010-03-19 + -pagecontent.xsd |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+addDefaultSchemas()
+Adds the internal default schemas to the list of schema sources.
+ |
+
addSchemaSource, addSchemaSource, getLatestSchemaVersion, getSchemaParser, getValidator, getValidatorForLatestVersion, isDefaultSchemaclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic PageXmlModelAndValidatorProvider() + throws org.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasException+
NoSchemasException - Schema resources not foundorg.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasExceptionpublic PageXmlModelAndValidatorProvider(java.lang.String schemaRootFolder, + java.lang.String schemaFilename) + throws org.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasException+
schemaRootFolder - schemaFilename - NoSchemasException - No schema files found at the given location.org.primaresearch.io.xml.XmlModelAndValidatorProvider.NoSchemasExceptionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/StreamTarget.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/StreamTarget.html new file mode 100644 index 00000000..d5995c62 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/StreamTarget.html @@ -0,0 +1,265 @@ + + + + + +public class StreamTarget +extends java.lang.Object +implements OutputTarget+
| Constructor and Description | +
|---|
StreamTarget(java.io.OutputStream outputStream) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.io.OutputStream |
+getOutputStream() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlNameProvider.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlNameProvider.html new file mode 100644 index 00000000..870f100e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlNameProvider.html @@ -0,0 +1,214 @@ + + + + + +public interface XmlNameProvider
+| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getXmlName(ContentType type) |
+
java.lang.String getXmlName(ContentType type)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageReader.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageReader.html new file mode 100644 index 00000000..9582f901 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageReader.html @@ -0,0 +1,314 @@ + + + + + +public class XmlPageReader +extends java.lang.Object +implements PageReader+
| Constructor and Description | +
|---|
XmlPageReader(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<org.primaresearch.io.xml.IOError> |
+getErrors()
+Returns a list of errors that occurred on the last call of read().
+ |
+
java.util.List<org.primaresearch.io.xml.IOError> |
+getWarnings()
+Returns a list of warnings that occurred on the last call of read().
+ |
+
Page |
+read(InputSource source)
+Reads a PAGE XML file and returns a Page object.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic XmlPageReader(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider)+
validatorProvider - Schema validator provider. (optional, set to null if no validation required).public Page read(InputSource source) + throws org.primaresearch.io.UnsupportedFormatVersionException+
read in interface PageReadersource - FileInput representing an XML filejava.lang.IllegalArgumentException - Wrong input source typeorg.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionExceptionorg.primaresearch.io.UnsupportedFormatVersionExceptionpublic java.util.List<org.primaresearch.io.xml.IOError> getErrors()+
public java.util.List<org.primaresearch.io.xml.IOError> getWarnings()+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter.html new file mode 100644 index 00000000..02c11d1f --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter.html @@ -0,0 +1,293 @@ + + + + + +public interface XmlPageWriter +extends PageWriter+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+getConversionInformation()
+Returns format conversion related messages
+ |
+
java.lang.String |
+getNamespace()
+Returns the name space.
+ |
+
java.lang.String |
+getSchemaLocation()
+Returns the location of the schema (e.g.
+ |
+
java.lang.String |
+getSchemaUrl()
+Returns the URL of the schema file (e.g.
+ |
+
java.lang.String |
+getSchemaVersion()
+Returns the XML schema version the writer supports (in format yyyy-mm-dd).
+ |
+
validate, writejava.lang.String getSchemaVersion()+
java.lang.String getSchemaLocation()+
java.lang.String getSchemaUrl()+
java.lang.String getNamespace()+
java.util.List<ConversionMessage> getConversionInformation()+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter_2010_03_19.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter_2010_03_19.html new file mode 100644 index 00000000..77d2b727 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter_2010_03_19.html @@ -0,0 +1,437 @@ + + + + + +public class XmlPageWriter_2010_03_19 +extends java.lang.Object +implements XmlPageWriter+
| Constructor and Description | +
|---|
XmlPageWriter_2010_03_19(org.primaresearch.io.xml.XmlValidator validator)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+getConversionInformation()
+Returns format conversion related messages
+ |
+
java.util.List<org.primaresearch.io.xml.IOError> |
+getErrors() |
+
java.lang.String |
+getNamespace()
+Returns the name space.
+ |
+
java.lang.String |
+getSchemaLocation()
+Returns the location of the schema (e.g.
+ |
+
java.lang.String |
+getSchemaUrl()
+Returns the URL of the schema file (e.g.
+ |
+
java.lang.String |
+getSchemaVersion()
+Returns the XML schema version the writer supports (in format yyyy-mm-dd).
+ |
+
java.util.List<org.primaresearch.io.xml.IOError> |
+getWarnings() |
+
boolean |
+validate(Page page)
+Validates the given Page object against the XML schema.
+ |
+
boolean |
+write(Page page,
+ OutputTarget target)
+Writes the given Page object to an XML file.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic XmlPageWriter_2010_03_19(org.primaresearch.io.xml.XmlValidator validator)+
validator - Optional schema validator (use null if not required).public java.lang.String getSchemaVersion()+
XmlPageWritergetSchemaVersion in interface XmlPageWriterpublic java.lang.String getSchemaLocation()+
XmlPageWritergetSchemaLocation in interface XmlPageWriterpublic java.lang.String getSchemaUrl()+
XmlPageWritergetSchemaUrl in interface XmlPageWriterpublic java.lang.String getNamespace()+
XmlPageWritergetNamespace in interface XmlPageWriterpublic boolean write(Page page, + OutputTarget target) + throws org.primaresearch.io.UnsupportedFormatVersionException+
write in interface PageWriterpage - Page objecttarget - FileTarget representing an XML fileorg.primaresearch.io.UnsupportedFormatVersionExceptionpublic boolean validate(Page page) + throws org.primaresearch.io.UnsupportedFormatVersionException+
validate in interface PageWriterpage - Page objectorg.primaresearch.io.UnsupportedFormatVersionExceptionpublic java.util.List<org.primaresearch.io.xml.IOError> getErrors()+
public java.util.List<org.primaresearch.io.xml.IOError> getWarnings()+
public java.util.List<ConversionMessage> getConversionInformation()+
XmlPageWritergetConversionInformation in interface XmlPageWriterCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter_2013_07_15.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter_2013_07_15.html new file mode 100644 index 00000000..fab02616 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/XmlPageWriter_2013_07_15.html @@ -0,0 +1,443 @@ + + + + + +public class XmlPageWriter_2013_07_15 +extends java.lang.Object +implements XmlPageWriter+
| Constructor and Description | +
|---|
XmlPageWriter_2013_07_15(org.primaresearch.io.xml.XmlValidator validator)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+getConversionInformation()
+Returns format conversion related messages
+ |
+
java.util.List<org.primaresearch.io.xml.IOError> |
+getErrors()
+Returns a list of writing errors
+ |
+
java.lang.String |
+getNamespace()
+Returns the name space.
+ |
+
java.lang.String |
+getSchemaLocation()
+Returns the location of the schema (e.g.
+ |
+
java.lang.String |
+getSchemaUrl()
+Returns the URL of the schema file (e.g.
+ |
+
java.lang.String |
+getSchemaVersion()
+Returns the XML schema version the writer supports (in format yyyy-mm-dd).
+ |
+
java.util.List<org.primaresearch.io.xml.IOError> |
+getWarnings()
+Returns a list of writing warnings
+ |
+
boolean |
+validate(Page page)
+Validates the given Page object against the XML schema.
+ |
+
boolean |
+write(Page page,
+ OutputTarget target)
+Writes the given Page object to an XML file.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic XmlPageWriter_2013_07_15(org.primaresearch.io.xml.XmlValidator validator)+
validator - Optional schema validator (use null if not required).public java.lang.String getSchemaVersion()+
XmlPageWritergetSchemaVersion in interface XmlPageWriterpublic java.lang.String getSchemaLocation()+
XmlPageWritergetSchemaLocation in interface XmlPageWriterpublic java.lang.String getSchemaUrl()+
XmlPageWritergetSchemaUrl in interface XmlPageWriterpublic java.lang.String getNamespace()+
XmlPageWritergetNamespace in interface XmlPageWriterpublic boolean write(Page page, + OutputTarget target) + throws org.primaresearch.io.UnsupportedFormatVersionException+
write in interface PageWriterpage - Page objecttarget - FileTarget representing an XML fileorg.primaresearch.io.UnsupportedFormatVersionExceptionpublic boolean validate(Page page) + throws org.primaresearch.io.UnsupportedFormatVersionException+
validate in interface PageWriterpage - Page objectorg.primaresearch.io.UnsupportedFormatVersionExceptionpublic java.util.List<org.primaresearch.io.xml.IOError> getErrors()+
public java.util.List<org.primaresearch.io.xml.IOError> getWarnings()+
public java.util.List<ConversionMessage> getConversionInformation()+
XmlPageWritergetConversionInformation in interface XmlPageWriterCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/DefaultXmlNames.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/DefaultXmlNames.html new file mode 100644 index 00000000..b51c35cc --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/DefaultXmlNames.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/MetsMultiPageReader.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/MetsMultiPageReader.html new file mode 100644 index 00000000..a5d7ed56 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/MetsMultiPageReader.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageErrorHandler.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageErrorHandler.html new file mode 100644 index 00000000..a54a9acb --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageErrorHandler.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageXmlInputOutput.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageXmlInputOutput.html new file mode 100644 index 00000000..bef2e039 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageXmlInputOutput.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static PageXmlInputOutput |
+PageXmlInputOutput.getInstance()
+Returns the instance of the singleton.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageXmlModelAndValidatorProvider.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageXmlModelAndValidatorProvider.html new file mode 100644 index 00000000..76a8909b --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/PageXmlModelAndValidatorProvider.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/StreamTarget.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/StreamTarget.html new file mode 100644 index 00000000..65529de8 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/StreamTarget.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlNameProvider.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlNameProvider.html new file mode 100644 index 00000000..d9445d26 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlNameProvider.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+DefaultXmlNames
+Class containing hard coded XML element and attribute names for the PAGE format.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageReader.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageReader.html new file mode 100644 index 00000000..18508017 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageReader.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static XmlPageReader |
+PageXmlInputOutput.getReader()
+Creates and returns an XML reader for PAGE.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter.html new file mode 100644 index 00000000..9134b4d4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter.html @@ -0,0 +1,185 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+XmlPageWriter_2010_03_19
+Page writer implementation for XML files.
+ |
+
class |
+XmlPageWriter_2013_07_15
+Page writer implementation for XML files.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static XmlPageWriter |
+PageXmlInputOutput.getWriter(org.primaresearch.io.xml.XmlFormatVersion schemaVersion)
+Creates and returns an XML writer for PAGE using the specified schema version.
+ |
+
static XmlPageWriter |
+PageXmlInputOutput.getWriterForLastestXmlFormat()
+Creates and returns an XML writer for PAGE using the latest schema version.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter_2010_03_19.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter_2010_03_19.html new file mode 100644 index 00000000..0dec7eb1 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter_2010_03_19.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter_2013_07_15.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter_2013_07_15.html new file mode 100644 index 00000000..5913dfe3 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/class-use/XmlPageWriter_2013_07_15.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-frame.html new file mode 100644 index 00000000..fbe61d74 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-frame.html @@ -0,0 +1,32 @@ + + + + + +| Interface | +Description | +
|---|---|
| XmlNameProvider | +
+ Provides the XML element names for content objects.
+ |
+
| XmlPageWriter | +
+ Interface for page writers producing XML.
+ |
+
| Class | +Description | +
|---|---|
| DefaultXmlNames | +
+ Class containing hard coded XML element and attribute names for the PAGE format.
+ |
+
| MetsMultiPageReader | +
+ Reader for multiple page file defined in METS XML format.
+ |
+
| PageErrorHandler | +
+ Error handler implementation that collects errors and warnings.
+ |
+
| PageXmlInputOutput | +
+ Central access point for reading and writing PAGE XML.
++ + Note: Page objects can only be saved using the XML format they are set to. |
+
| PageXmlModelAndValidatorProvider | +
+ Provides access to models and validators for different PAGE XML schema versions.
+ |
+
| StreamTarget | +
+ Generic output target can be any type of stream.
+ |
+
| XmlPageReader | +
+ Page reader implementation for XML files (supports validation against schema).
+ |
+
| XmlPageWriter_2010_03_19 | +
+ Page writer implementation for XML files.
+ |
+
| XmlPageWriter_2013_07_15 | +
+ Page writer implementation for XML files.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-tree.html new file mode 100644 index 00000000..52f2ae4a --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-tree.html @@ -0,0 +1,150 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-use.html new file mode 100644 index 00000000..82dce11d --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/package-use.html @@ -0,0 +1,168 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| Class and Description | +
|---|
| PageXmlInputOutput
+ Central access point for reading and writing PAGE XML.
++ + Note: Page objects can only be saved using the XML format they are set to. |
+
| XmlNameProvider
+ Provides the XML element names for content objects.
+ |
+
| XmlPageReader
+ Page reader implementation for XML files (supports validation against schema).
+ |
+
| XmlPageWriter
+ Interface for page writers producing XML.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler.html new file mode 100644 index 00000000..4d4cb467 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler.html @@ -0,0 +1,284 @@ + + + + + +public abstract class SaxPageHandler
+extends org.xml.sax.helpers.DefaultHandler
+| Constructor and Description | +
|---|
SaxPageHandler() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract Page |
+getPageObject()
+Returns the page object that has been created from XML
+ |
+
characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warningclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandlerFactory.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandlerFactory.html new file mode 100644 index 00000000..47ca4068 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandlerFactory.html @@ -0,0 +1,267 @@ + + + + + +public class SaxPageHandlerFactory
+extends java.lang.Object
+| Constructor and Description | +
|---|
SaxPageHandlerFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static SaxPageHandler |
+createHandler(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider,
+ org.primaresearch.io.xml.XmlFormatVersion schemaVersion)
+Creates a handler for the given format
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static SaxPageHandler createHandler(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider, + org.primaresearch.io.xml.XmlFormatVersion schemaVersion)+
validatorProvider - Provider for XML validatorsschemaVersion - XML schema version for the formatCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandlerLegacy.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandlerLegacy.html new file mode 100644 index 00000000..5858186e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandlerLegacy.html @@ -0,0 +1,380 @@ + + + + + +public class SaxPageHandlerLegacy +extends SaxPageHandler+
| Constructor and Description | +
|---|
SaxPageHandlerLegacy(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider,
+ org.primaresearch.io.xml.XmlFormatVersion schemaVersion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+characters(char[] ch,
+ int start,
+ int length)
+Receive notification of character data inside an element.
+ |
+
void |
+endElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName)
+Receive notification of the end of an element.
+ |
+
Page |
+getPageObject()
+Returns the page object that has been created from XML
+ |
+
void |
+startElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName,
+ org.xml.sax.Attributes atts)
+Receive notification of the start of an element.
+ |
+
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warningclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic SaxPageHandlerLegacy(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider, + org.primaresearch.io.xml.XmlFormatVersion schemaVersion)+
public Page getPageObject()+
SaxPageHandlergetPageObject in class SaxPageHandlerpublic void startElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName, + org.xml.sax.Attributes atts) + throws org.xml.sax.SAXException+
startElement in interface org.xml.sax.ContentHandlerstartElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.atts - - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void endElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName) + throws org.xml.sax.SAXException+
endElement in interface org.xml.sax.ContentHandlerendElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void characters(char[] ch, + int start, + int length) + throws org.xml.sax.SAXException+
characters in interface org.xml.sax.ContentHandlercharacters in class org.xml.sax.helpers.DefaultHandlerch - - The characters.start - - The start position in the character array.length - - The number of characters to use from the character array.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_2010_03_19.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_2010_03_19.html new file mode 100644 index 00000000..da626e4b --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_2010_03_19.html @@ -0,0 +1,380 @@ + + + + + +public class SaxPageHandler_2010_03_19 +extends SaxPageHandler+
| Constructor and Description | +
|---|
SaxPageHandler_2010_03_19(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider,
+ org.primaresearch.io.xml.XmlFormatVersion schemaVersion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+characters(char[] ch,
+ int start,
+ int length)
+Receive notification of character data inside an element.
+ |
+
void |
+endElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName)
+Receive notification of the end of an element.
+ |
+
Page |
+getPageObject()
+Returns the page object that has been created from XML
+ |
+
void |
+startElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName,
+ org.xml.sax.Attributes atts)
+Receive notification of the start of an element.
+ |
+
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warningclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic SaxPageHandler_2010_03_19(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider, + org.primaresearch.io.xml.XmlFormatVersion schemaVersion)+
public Page getPageObject()+
SaxPageHandlergetPageObject in class SaxPageHandlerpublic void startElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName, + org.xml.sax.Attributes atts) + throws org.xml.sax.SAXException+
startElement in interface org.xml.sax.ContentHandlerstartElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.atts - - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void endElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName) + throws org.xml.sax.SAXException+
endElement in interface org.xml.sax.ContentHandlerendElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void characters(char[] ch, + int start, + int length) + throws org.xml.sax.SAXException+
characters in interface org.xml.sax.ContentHandlercharacters in class org.xml.sax.helpers.DefaultHandlerch - - The characters.start - - The start position in the character array.length - - The number of characters to use from the character array.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_2013_07_15.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_2013_07_15.html new file mode 100644 index 00000000..d7054cda --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_2013_07_15.html @@ -0,0 +1,380 @@ + + + + + +public class SaxPageHandler_2013_07_15 +extends SaxPageHandler+
| Constructor and Description | +
|---|
SaxPageHandler_2013_07_15(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider,
+ org.primaresearch.io.xml.XmlFormatVersion schemaVersion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+characters(char[] ch,
+ int start,
+ int length)
+Receive notification of character data inside an element.
+ |
+
void |
+endElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName)
+Receive notification of the end of an element.
+ |
+
Page |
+getPageObject()
+Returns the page object that has been created from XML
+ |
+
void |
+startElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName,
+ org.xml.sax.Attributes atts)
+Receive notification of the start of an element.
+ |
+
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warningclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic SaxPageHandler_2013_07_15(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider, + org.primaresearch.io.xml.XmlFormatVersion schemaVersion)+
public Page getPageObject()+
SaxPageHandlergetPageObject in class SaxPageHandlerpublic void startElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName, + org.xml.sax.Attributes atts) + throws org.xml.sax.SAXException+
startElement in interface org.xml.sax.ContentHandlerstartElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.atts - - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void endElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName) + throws org.xml.sax.SAXException+
endElement in interface org.xml.sax.ContentHandlerendElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void characters(char[] ch, + int start, + int length) + throws org.xml.sax.SAXException+
characters in interface org.xml.sax.ContentHandlercharacters in class org.xml.sax.helpers.DefaultHandlerch - - The characters.start - - The start position in the character array.length - - The number of characters to use from the character array.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_AbbyyFineReader10.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_AbbyyFineReader10.html new file mode 100644 index 00000000..404faa4a --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_AbbyyFineReader10.html @@ -0,0 +1,380 @@ + + + + + +public class SaxPageHandler_AbbyyFineReader10 +extends SaxPageHandler+
| Constructor and Description | +
|---|
SaxPageHandler_AbbyyFineReader10(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider,
+ org.primaresearch.io.xml.XmlFormatVersion schemaVersion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+characters(char[] ch,
+ int start,
+ int length)
+Receive notification of character data inside an element.
+ |
+
void |
+endElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName)
+Receive notification of the end of an element.
+ |
+
Page |
+getPageObject()
+Returns the page object that has been created from XML
+ |
+
void |
+startElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName,
+ org.xml.sax.Attributes atts)
+Receive notification of the start of an element.
+ |
+
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warningclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic SaxPageHandler_AbbyyFineReader10(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider, + org.primaresearch.io.xml.XmlFormatVersion schemaVersion)+
public Page getPageObject()+
SaxPageHandlergetPageObject in class SaxPageHandlerpublic void startElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName, + org.xml.sax.Attributes atts) + throws org.xml.sax.SAXException+
startElement in interface org.xml.sax.ContentHandlerstartElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.atts - - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void endElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName) + throws org.xml.sax.SAXException+
endElement in interface org.xml.sax.ContentHandlerendElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void characters(char[] ch, + int start, + int length) + throws org.xml.sax.SAXException+
characters in interface org.xml.sax.ContentHandlercharacters in class org.xml.sax.helpers.DefaultHandlerch - - The characters.start - - The start position in the character array.length - - The number of characters to use from the character array.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_Alto_2_1.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_Alto_2_1.html new file mode 100644 index 00000000..43238d60 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_Alto_2_1.html @@ -0,0 +1,380 @@ + + + + + +public class SaxPageHandler_Alto_2_1 +extends SaxPageHandler+
| Constructor and Description | +
|---|
SaxPageHandler_Alto_2_1(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider,
+ org.primaresearch.io.xml.XmlFormatVersion schemaVersion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+characters(char[] ch,
+ int start,
+ int length)
+Receive notification of character data inside an element.
+ |
+
void |
+endElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName)
+Receive notification of the end of an element.
+ |
+
Page |
+getPageObject()
+Returns the page object that has been created from XML
+ |
+
void |
+startElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName,
+ org.xml.sax.Attributes atts)
+Receive notification of the start of an element.
+ |
+
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warningclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic SaxPageHandler_Alto_2_1(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider, + org.primaresearch.io.xml.XmlFormatVersion schemaVersion)+
public Page getPageObject()+
SaxPageHandlergetPageObject in class SaxPageHandlerpublic void startElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName, + org.xml.sax.Attributes atts) + throws org.xml.sax.SAXException+
startElement in interface org.xml.sax.ContentHandlerstartElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.atts - - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void endElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName) + throws org.xml.sax.SAXException+
endElement in interface org.xml.sax.ContentHandlerendElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void characters(char[] ch, + int start, + int length) + throws org.xml.sax.SAXException+
characters in interface org.xml.sax.ContentHandlercharacters in class org.xml.sax.helpers.DefaultHandlerch - - The characters.start - - The start position in the character array.length - - The number of characters to use from the character array.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_Hocr.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_Hocr.html new file mode 100644 index 00000000..eaaa826f --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/SaxPageHandler_Hocr.html @@ -0,0 +1,378 @@ + + + + + +public class SaxPageHandler_Hocr +extends SaxPageHandler+
| Constructor and Description | +
|---|
SaxPageHandler_Hocr() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+characters(char[] ch,
+ int start,
+ int length)
+Receive notification of character data inside an element.
+ |
+
void |
+endElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName)
+Receive notification of the end of an element.
+ |
+
Page |
+getPageObject()
+Returns the page object that has been created from XML
+ |
+
void |
+startElement(java.lang.String namespaceURI,
+ java.lang.String localName,
+ java.lang.String qName,
+ org.xml.sax.Attributes atts)
+Receive notification of the start of an element.
+ |
+
endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warningclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic Page getPageObject()+
SaxPageHandlergetPageObject in class SaxPageHandlerpublic void startElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName, + org.xml.sax.Attributes atts) + throws org.xml.sax.SAXException+
startElement in interface org.xml.sax.ContentHandlerstartElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.atts - - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void endElement(java.lang.String namespaceURI, + java.lang.String localName, + java.lang.String qName) + throws org.xml.sax.SAXException+
endElement in interface org.xml.sax.ContentHandlerendElement in class org.xml.sax.helpers.DefaultHandlernamespaceURI - - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.localName - - The local name (without prefix), or the empty string if Namespace processing is not being performed.qName - - The qualified name (with prefix), or the empty string if qualified names are not available.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.public void characters(char[] ch, + int start, + int length) + throws org.xml.sax.SAXException+
characters in interface org.xml.sax.ContentHandlercharacters in class org.xml.sax.helpers.DefaultHandlerch - - The characters.start - - The start position in the character array.length - - The number of characters to use from the character array.org.xml.sax.SAXException - - Any SAX exception, possibly wrapping another exception.Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler.html new file mode 100644 index 00000000..89c294a2 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler.html @@ -0,0 +1,204 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml.sax | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SaxPageHandler_2010_03_19
+Legacy PAGE XML handler for 2010 format.
+ |
+
class |
+SaxPageHandler_2013_07_15
+XML handler for 2013 PAGE format.
+ |
+
class |
+SaxPageHandler_AbbyyFineReader10
+Experimental SAX XML handler to read Abbyy FineReader 10 XML files.
+ |
+
class |
+SaxPageHandler_Alto_2_1
+Experimental SAX XML handler to read ALTO XML files.
+ |
+
class |
+SaxPageHandler_Hocr
+Experimental SAX XML handler to read HOCR XHTML files (e.g.
+ |
+
class |
+SaxPageHandlerLegacy
+Handler for PAGE schema version 2010-01-12 and older.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static SaxPageHandler |
+SaxPageHandlerFactory.createHandler(org.primaresearch.io.xml.XmlModelAndValidatorProvider validatorProvider,
+ org.primaresearch.io.xml.XmlFormatVersion schemaVersion)
+Creates a handler for the given format
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandlerFactory.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandlerFactory.html new file mode 100644 index 00000000..e259511e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandlerFactory.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandlerLegacy.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandlerLegacy.html new file mode 100644 index 00000000..4df31878 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandlerLegacy.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_2010_03_19.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_2010_03_19.html new file mode 100644 index 00000000..87bbd2b6 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_2010_03_19.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_2013_07_15.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_2013_07_15.html new file mode 100644 index 00000000..016227fa --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_2013_07_15.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_AbbyyFineReader10.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_AbbyyFineReader10.html new file mode 100644 index 00000000..53b24b12 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_AbbyyFineReader10.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_Alto_2_1.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_Alto_2_1.html new file mode 100644 index 00000000..3299872e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_Alto_2_1.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_Hocr.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_Hocr.html new file mode 100644 index 00000000..84939ab9 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/class-use/SaxPageHandler_Hocr.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-frame.html new file mode 100644 index 00000000..f0707aa4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-frame.html @@ -0,0 +1,26 @@ + + + + + +| Class | +Description | +
|---|---|
| SaxPageHandler | +
+ Abstract base class for SAX handlers intended for PAGE XML.
+ |
+
| SaxPageHandler_2010_03_19 | +
+ Legacy PAGE XML handler for 2010 format.
+ |
+
| SaxPageHandler_2013_07_15 | +
+ XML handler for 2013 PAGE format.
+ |
+
| SaxPageHandler_AbbyyFineReader10 | +
+ Experimental SAX XML handler to read Abbyy FineReader 10 XML files.
+ |
+
| SaxPageHandler_Alto_2_1 | +
+ Experimental SAX XML handler to read ALTO XML files.
+ |
+
| SaxPageHandler_Hocr | +
+ Experimental SAX XML handler to read HOCR XHTML files (e.g.
+ |
+
| SaxPageHandlerFactory | +
+ Creates SAX handlers for PAGE XML.
+ |
+
| SaxPageHandlerLegacy | +
+ Handler for PAGE schema version 2010-01-12 and older.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-tree.html new file mode 100644 index 00000000..8b1f655b --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-tree.html @@ -0,0 +1,143 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-use.html new file mode 100644 index 00000000..1bdbb78c --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/io/xml/sax/package-use.html @@ -0,0 +1,151 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml.sax | ++ |
| Class and Description | +
|---|
| SaxPageHandler
+ Abstract base class for SAX handlers intended for PAGE XML.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/GeometricObjectImpl.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/GeometricObjectImpl.html new file mode 100644 index 00000000..df246db5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/GeometricObjectImpl.html @@ -0,0 +1,301 @@ + + + + + +public class GeometricObjectImpl +extends java.lang.Object +implements GeometricObject+
| Constructor and Description | +
|---|
GeometricObjectImpl(org.primaresearch.maths.geometry.Polygon coords)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
org.primaresearch.maths.geometry.Polygon |
+getCoords()
+Returns the location of the object.
+ |
+
void |
+setCoords(org.primaresearch.maths.geometry.Polygon coords)
+Sets the location of the object
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic GeometricObjectImpl(org.primaresearch.maths.geometry.Polygon coords) + throws java.lang.IllegalArgumentException+
coords - The polygon locating the object on the page.java.lang.IllegalArgumentException - if the passed polygon is null.public org.primaresearch.maths.geometry.Polygon getCoords()+
GeometricObjectgetCoords in interface GeometricObjectpublic void setCoords(org.primaresearch.maths.geometry.Polygon coords)+
GeometricObjectsetCoords in interface GeometricObjectcoords - A polygonCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/GeometricObjectPositionComparator.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/GeometricObjectPositionComparator.html new file mode 100644 index 00000000..f4b35a49 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/GeometricObjectPositionComparator.html @@ -0,0 +1,263 @@ + + + + + +public class GeometricObjectPositionComparator +extends java.lang.Object +implements java.util.Comparator<GeometricObject>+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+compare(GeometricObject obj1,
+ GeometricObject obj2) |
+
static GeometricObjectPositionComparator |
+getInstance(boolean sortByX)
+Creates a comparator
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitequalspublic static GeometricObjectPositionComparator getInstance(boolean sortByX)+
sortByX - Set to true to sort objects left-to-right or to false to sort top-to-bottompublic int compare(GeometricObject obj1, + GeometricObject obj2)+
compare in interface java.util.Comparator<GeometricObject>Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/PageLayout.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/PageLayout.html new file mode 100644 index 00000000..ffc7ece7 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/PageLayout.html @@ -0,0 +1,819 @@ + + + + + +public class PageLayout
+extends java.lang.Object
+| Constructor and Description | +
|---|
PageLayout(ContentFactory contentFactory)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+changeTypeOfRegion(ContentObject region,
+ RegionType newType)
+Creates a region object with the id of the given object and the new region type.
+ |
+
Layers |
+createLayers()
+Creates and returns a new layers object for the layout.
+ |
+
ReadingOrder |
+createReadingOrder()
+Creates and returns a new reading order for the layout.
+ |
+
Region |
+createRegion(RegionType type)
+Creates a region of the specified type.
+ |
+
Region |
+createRegion(RegionType type,
+ java.lang.String id)
+Creates a region of the specified type.
+ |
+
Region |
+createRegion(RegionType type,
+ java.lang.String id,
+ RegionContainer parentRegion)
+Creates a region of the specified type.
+ |
+
GeometricObject |
+getBorder()
+Returns the page border object
+ |
+
int |
+getHeight()
+Returns the page height.
+ |
+
Layers |
+getLayers()
+Returns the layers of the layout.
+ |
+
ContentObject |
+getObject(ContentType type,
+ java.lang.String id)
+Returns the content object of given type and ID
+ |
+
ContentObject |
+getObjectAt(int x,
+ int y,
+ ContentType type)
+Looks for a content object of a specific type at the given position within the document page.
+ |
+
ContentObjectRelation |
+getParentChildRelation(ContentType childType,
+ java.lang.String childId)
+Returns a parent-child relation object
+ |
+
GeometricObject |
+getPrintSpace()
+Returns the page print space object.
+ |
+
ReadingOrder |
+getReadingOrder()
+Returns the reading order of the layout.
+ |
+
Region |
+getRegion(org.primaresearch.ident.Id regionId)
+Returns the region with the given ID.
+ |
+
Region |
+getRegion(int index)
+Returns the region at the specified index.
+ |
+
Region |
+getRegion(java.lang.String regionId)
+Returns the region with the given ID.
+ |
+
Region |
+getRegionAt(int x,
+ int y)
+Looks for a region at the given position within the document page.
+ |
+
int |
+getRegionCount()
+Returns the number of regions in this page layout.
+ |
+
java.util.List<Region> |
+getRegionsSorted()
+Returns a sorted list of all regions.
+ |
+
Relations |
+getRelations()
+Returns the container for all relations between regions.
+ |
+
int |
+getWidth()
+Returns the page width.
+ |
+
boolean |
+hasLowLevelTextObject(LowLevelTextType type)
+Checks if this page layout contains text objects of the given type
+ |
+
ContentIterator |
+iterator(ContentType contentType)
+Returns a new iterator for a specific page content type.
+ |
+
ContentIterator |
+iterator(ContentType contentType,
+ Layer layer)
+Returns a new iterator for a specific page content type.
+ |
+
void |
+removeRegion(org.primaresearch.ident.Id regionId)
+Removes the specified region object from the page layout.
+ |
+
void |
+removeRegion(org.primaresearch.ident.Id regionId,
+ boolean unregisterId)
+Removes the specified region object from the page layout.
+ |
+
void |
+removeRegion(int index)
+Removes the region at the specified index from the page layout.
+ |
+
void |
+removeRegion(int index,
+ boolean unregisterId)
+Removes the region at the specified index from the page layout.
+ |
+
void |
+setBorder(GeometricObject border)
+Sets the page border.
+ |
+
void |
+setPrintSpace(GeometricObject printSpace)
+Sets the page print space.
+ |
+
void |
+setSize(int width,
+ int height)
+Sets width and height of the page.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic PageLayout(ContentFactory contentFactory)+
contentFactory - Internal factory to create content such as regions, lines, reading order, ...public Region createRegion(RegionType type)+
type - Type of region (e.g. TextRegion, ImageRegion, ...)public Region createRegion(RegionType type, + java.lang.String id)+
type - Type of region (e.g. TextRegion, ImageRegion, ...)public Region createRegion(RegionType type, + java.lang.String id, + RegionContainer parentRegion)+
type - Type of region (e.g. TextRegion, ImageRegion, ...)id - Preferred ID for the region (not guaranteed, check the returned region for the actual ID)parentRegion - Parent region (for nesting of regions)public int getRegionCount()+
public Region getRegion(int index)+
java.lang.IndexOutOfBoundsExceptionpublic Region getRegion(org.primaresearch.ident.Id regionId)+
public Region getRegion(java.lang.String regionId)+
public Region getRegionAt(int x, + int y)+
public ContentObject getObjectAt(int x, + int y, + ContentType type)+
public ContentObject getObject(ContentType type, + java.lang.String id)+
type - Object type (e.g. region or text line)id - Object idnull if it could not be foundpublic ContentObjectRelation getParentChildRelation(ContentType childType, + java.lang.String childId)+
childType - Content type of the childchildId - ID of the childnullpublic boolean hasLowLevelTextObject(LowLevelTextType type)+
public GeometricObject getBorder()+
public void setBorder(GeometricObject border)+
public GeometricObject getPrintSpace()+
public void setPrintSpace(GeometricObject printSpace)+
public int getWidth()+
public int getHeight()+
public void setSize(int width, + int height)+
public ReadingOrder getReadingOrder()+
public ReadingOrder createReadingOrder()+
public Layers getLayers()+
public Layers createLayers()+
public void removeRegion(org.primaresearch.ident.Id regionId)+
public void removeRegion(org.primaresearch.ident.Id regionId, + boolean unregisterId)+
unregisterId - If set to true the ID will be removed from the ID register and is free to be used againpublic void removeRegion(int index)+
java.lang.IndexOutOfBoundsExceptionpublic void removeRegion(int index, + boolean unregisterId)+
unregisterId - If set to true the ID will be removed from the ID register and is free to be used againjava.lang.IndexOutOfBoundsExceptionpublic java.util.List<Region> getRegionsSorted()+
public Relations getRelations()+
public ContentObject changeTypeOfRegion(ContentObject region, + RegionType newType) + throws java.lang.IllegalArgumentException+
region - Region to changenewType - New region typejava.lang.IllegalArgumentException - If the input is not a regionpublic ContentIterator iterator(ContentType contentType)+
contentType - A specific region type or low level text object type. Use null for an iterator that includes all regions.public ContentIterator iterator(ContentType contentType, + Layer layer)+
contentType - A specific region type or low level text object type. Use null for an iterator that includes all regions.layer - Restrict the iterator to this layer (use null for no restriction)Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/GeometricObjectImpl.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/GeometricObjectImpl.html new file mode 100644 index 00000000..737becd4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/GeometricObjectImpl.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/GeometricObjectPositionComparator.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/GeometricObjectPositionComparator.html new file mode 100644 index 00000000..22f29f69 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/GeometricObjectPositionComparator.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static GeometricObjectPositionComparator |
+GeometricObjectPositionComparator.getInstance(boolean sortByX)
+Creates a comparator
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/PageLayout.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/PageLayout.html new file mode 100644 index 00000000..700201a8 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/class-use/PageLayout.html @@ -0,0 +1,347 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| org.primaresearch.dla.page.layout.converter | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PageLayout |
+Page.getLayout()
+Returns the page layout
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+LayoutConverter.checkForCompliance(PageLayout layout)
+Checks if the given page layout is consistent to the target format version
+ of this converter.
+ |
+
java.util.List<ConversionMessage> |
+Converter_2013_07_15_to_2010_03_19.checkForCompliance(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2010_03_19_to_2010_01_12.checkForCompliance(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2010_01_12_to_2009_03_16.checkForCompliance(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+ChainConverter.checkForCompliance(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+LayoutConverter.convert(PageLayout layout)
+Converts the given page layout to the specified target format.
+ |
+
java.util.List<ConversionMessage> |
+Converter_2013_07_15_to_2010_03_19.convert(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2010_03_19_to_2010_01_12.convert(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2010_01_12_to_2009_03_16.convert(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+ChainConverter.convert(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2013_07_15_to_2010_03_19.run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
java.util.List<ConversionMessage> |
+Converter_2010_03_19_to_2010_01_12.run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
java.util.List<ConversionMessage> |
+Converter_2010_01_12_to_2009_03_16.run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
| Constructor and Description | +
|---|
Layers(PageLayout layout,
+ org.primaresearch.ident.IdRegister idRegister,
+ ContentFactory contentFactory)
+Constructor
+ |
+
ReadingOrder(PageLayout layout,
+ org.primaresearch.ident.IdRegister idRegister,
+ ContentFactory contentFactory)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Layers |
+ContentFactory.createLayers(PageLayout layout)
+Creates a layer container
+ |
+
ReadingOrder |
+ContentFactory.createReadingOrder(PageLayout layout)
+Creates a reading order object
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected PageLayout |
+RegionIterator.pageLayout |
+
| Constructor and Description | +
|---|
LowLevelTextObjectIterator(PageLayout pageLayout,
+ LowLevelTextType contentType,
+ Layer layer)
+Constructor
+ |
+
RegionIterator(PageLayout pageLayout,
+ RegionType contentType,
+ Layer layer)
+Constructor
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ChainConverter.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ChainConverter.html new file mode 100644 index 00000000..8a926c82 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ChainConverter.html @@ -0,0 +1,355 @@ + + + + + +public class ChainConverter +extends java.lang.Object +implements LayoutConverter+
| Constructor and Description | +
|---|
ChainConverter() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addConverter(LayoutConverter converter)
+Adds a converter to the chain
+ |
+
java.util.List<ConversionMessage> |
+checkForCompliance(PageLayout layout)
+Checks if the given page layout is consistent to the target format version
+ of this converter.
+ |
+
java.util.List<ConversionMessage> |
+convert(PageLayout layout)
+Converts the given page layout to the specified target format.
+ |
+
org.primaresearch.io.FormatVersion |
+getSourceVersion()
+Format version before the conversion
+ |
+
org.primaresearch.io.FormatVersion |
+getTargetVersion()
+Format version after the conversion
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void addConverter(LayoutConverter converter)+
converter - Converter objectpublic org.primaresearch.io.FormatVersion getSourceVersion()+
LayoutConvertergetSourceVersion in interface LayoutConverterpublic org.primaresearch.io.FormatVersion getTargetVersion()+
LayoutConvertergetTargetVersion in interface LayoutConverterpublic java.util.List<ConversionMessage> convert(PageLayout layout)+
LayoutConverterconvert in interface LayoutConverterpublic java.util.List<ConversionMessage> checkForCompliance(PageLayout layout)+
LayoutConvertercheckForCompliance in interface LayoutConverterCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ConversionMessage.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ConversionMessage.html new file mode 100644 index 00000000..b1ba810b --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ConversionMessage.html @@ -0,0 +1,366 @@ + + + + + +public class ConversionMessage
+extends java.lang.Object
+| Modifier and Type | +Field and Description | +
|---|---|
static int |
+CONVERSION_ADD_REQUIRED_REGION |
+
static int |
+CONVERSION_GENERAL |
+
static int |
+CONVERSION_RESET_INVALID_ATTRIBUTE |
+
| Constructor and Description | +
|---|
ConversionMessage(java.lang.String text)
+Constructor for general message
+ |
+
ConversionMessage(java.lang.String text,
+ int code)
+Constructor for specific message code
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getCode()
+Returns the message code (see
+CONVERSION_... constants) |
+
java.lang.String |
+getText()
+Returns the message content
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final int CONVERSION_GENERAL+
public static final int CONVERSION_RESET_INVALID_ATTRIBUTE+
public static final int CONVERSION_ADD_REQUIRED_REGION+
public ConversionMessage(java.lang.String text)+
text - Message contentpublic ConversionMessage(java.lang.String text, + int code)+
text - Message contentcode - Message code (see CONVERSION_... constants)Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ConverterHub.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ConverterHub.html new file mode 100644 index 00000000..d659eef4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/ConverterHub.html @@ -0,0 +1,269 @@ + + + + + +public class ConverterHub
+extends java.lang.Object
+| Modifier and Type | +Method and Description | +
|---|---|
static java.util.List<ConversionMessage> |
+checkForCompliance(Page page,
+ org.primaresearch.io.FormatVersion targetVersion)
+Checks if the given page (layout) complies with specified target format.
+ |
+
static java.util.List<ConversionMessage> |
+convert(Page page,
+ org.primaresearch.io.FormatModel targetModel)
+Converts the given page (layout) to the specified target format (might change attributes, attribute values and attribute constraints).
+ |
+
static ConverterHub |
+getInstance()
+Returns singleton instance
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static ConverterHub getInstance()+
public static java.util.List<ConversionMessage> convert(Page page, + org.primaresearch.io.FormatModel targetModel)+
page - Page object containing the layouttargetModel - Target model for a specific format versionpublic static java.util.List<ConversionMessage> checkForCompliance(Page page, + org.primaresearch.io.FormatVersion targetVersion)+
page - Page object containing the layouttargetVersion - Target format versionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2010_01_12_to_2009_03_16.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2010_01_12_to_2009_03_16.html new file mode 100644 index 00000000..dd0a6cf7 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2010_01_12_to_2009_03_16.html @@ -0,0 +1,361 @@ + + + + + +public class Converter_2010_01_12_to_2009_03_16 +extends java.lang.Object +implements LayoutConverter+
| Constructor and Description | +
|---|
Converter_2010_01_12_to_2009_03_16() |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+checkForCompliance(PageLayout layout)
+Checks if the given page layout is consistent to the target format version
+ of this converter.
+ |
+
java.util.List<ConversionMessage> |
+convert(PageLayout layout)
+Converts the given page layout to the specified target format.
+ |
+
org.primaresearch.io.FormatVersion |
+getSourceVersion()
+Format version before the conversion
+ |
+
org.primaresearch.io.FormatVersion |
+getTargetVersion()
+Format version after the conversion
+ |
+
java.util.List<ConversionMessage> |
+run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic Converter_2010_01_12_to_2009_03_16()+
public org.primaresearch.io.FormatVersion getSourceVersion()+
LayoutConvertergetSourceVersion in interface LayoutConverterpublic org.primaresearch.io.FormatVersion getTargetVersion()+
LayoutConvertergetTargetVersion in interface LayoutConverterpublic java.util.List<ConversionMessage> convert(PageLayout layout)+
LayoutConverterconvert in interface LayoutConverterpublic java.util.List<ConversionMessage> checkForCompliance(PageLayout layout)+
LayoutConvertercheckForCompliance in interface LayoutConverterpublic java.util.List<ConversionMessage> run(PageLayout layout, + boolean checkOnly)+
checkOnly - If true, no conversion is carried out (dry run).Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2010_03_19_to_2010_01_12.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2010_03_19_to_2010_01_12.html new file mode 100644 index 00000000..97fc8829 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2010_03_19_to_2010_01_12.html @@ -0,0 +1,361 @@ + + + + + +public class Converter_2010_03_19_to_2010_01_12 +extends java.lang.Object +implements LayoutConverter+
| Constructor and Description | +
|---|
Converter_2010_03_19_to_2010_01_12() |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+checkForCompliance(PageLayout layout)
+Checks if the given page layout is consistent to the target format version
+ of this converter.
+ |
+
java.util.List<ConversionMessage> |
+convert(PageLayout layout)
+Converts the given page layout to the specified target format.
+ |
+
org.primaresearch.io.FormatVersion |
+getSourceVersion()
+Format version before the conversion
+ |
+
org.primaresearch.io.FormatVersion |
+getTargetVersion()
+Format version after the conversion
+ |
+
java.util.List<ConversionMessage> |
+run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic Converter_2010_03_19_to_2010_01_12()+
public org.primaresearch.io.FormatVersion getSourceVersion()+
LayoutConvertergetSourceVersion in interface LayoutConverterpublic org.primaresearch.io.FormatVersion getTargetVersion()+
LayoutConvertergetTargetVersion in interface LayoutConverterpublic java.util.List<ConversionMessage> convert(PageLayout layout)+
LayoutConverterconvert in interface LayoutConverterpublic java.util.List<ConversionMessage> checkForCompliance(PageLayout layout)+
LayoutConvertercheckForCompliance in interface LayoutConverterpublic java.util.List<ConversionMessage> run(PageLayout layout, + boolean checkOnly)+
checkOnly - If true, no conversion is carried out (dry run).Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2013_07_15_to_2010_03_19.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2013_07_15_to_2010_03_19.html new file mode 100644 index 00000000..b8fa85ac --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/Converter_2013_07_15_to_2010_03_19.html @@ -0,0 +1,366 @@ + + + + + +public class Converter_2013_07_15_to_2010_03_19 +extends java.lang.Object +implements LayoutConverter+
| Constructor and Description | +
|---|
Converter_2013_07_15_to_2010_03_19() |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+checkForCompliance(PageLayout layout)
+Checks if the given page layout is consistent to the target format version
+ of this converter.
+ |
+
java.util.List<ConversionMessage> |
+convert(PageLayout layout)
+Converts the given page layout to the specified target format.
+ |
+
org.primaresearch.io.FormatVersion |
+getSourceVersion()
+Format version before the conversion
+ |
+
org.primaresearch.io.FormatVersion |
+getTargetVersion()
+Format version after the conversion
+ |
+
java.util.List<ConversionMessage> |
+run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic Converter_2013_07_15_to_2010_03_19()+
public org.primaresearch.io.FormatVersion getSourceVersion()+
LayoutConvertergetSourceVersion in interface LayoutConverterpublic org.primaresearch.io.FormatVersion getTargetVersion()+
LayoutConvertergetTargetVersion in interface LayoutConverterpublic java.util.List<ConversionMessage> convert(PageLayout layout)+
LayoutConverterconvert in interface LayoutConverterpublic java.util.List<ConversionMessage> checkForCompliance(PageLayout layout)+
LayoutConvertercheckForCompliance in interface LayoutConverterpublic java.util.List<ConversionMessage> run(PageLayout layout, + boolean checkOnly)+
checkOnly - If true, no conversion is carried out (dry run).Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/LayoutConverter.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/LayoutConverter.html new file mode 100644 index 00000000..e487ce5f --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/LayoutConverter.html @@ -0,0 +1,269 @@ + + + + + +public interface LayoutConverter
+| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+checkForCompliance(PageLayout layout)
+Checks if the given page layout is consistent to the target format version
+ of this converter.
+ |
+
java.util.List<ConversionMessage> |
+convert(PageLayout layout)
+Converts the given page layout to the specified target format.
+ |
+
org.primaresearch.io.FormatVersion |
+getSourceVersion()
+Format version before the conversion
+ |
+
org.primaresearch.io.FormatVersion |
+getTargetVersion()
+Format version after the conversion
+ |
+
org.primaresearch.io.FormatVersion getSourceVersion()+
org.primaresearch.io.FormatVersion getTargetVersion()+
java.util.List<ConversionMessage> convert(PageLayout layout)+
java.util.List<ConversionMessage> checkForCompliance(PageLayout layout)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ChainConverter.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ChainConverter.html new file mode 100644 index 00000000..cc9fd86a --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ChainConverter.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ConversionMessage.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ConversionMessage.html new file mode 100644 index 00000000..11c56bd8 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ConversionMessage.html @@ -0,0 +1,288 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| org.primaresearch.dla.page.io.xml | ++ |
| org.primaresearch.dla.page.layout.converter | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+Page.setFormatVersion(org.primaresearch.io.FormatModel formatModel)
+Converts the page to the specified format.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<ConversionMessage> |
+XmlPageWriter_2013_07_15.getConversionInformation() |
+
java.util.List<ConversionMessage> |
+XmlPageWriter_2010_03_19.getConversionInformation() |
+
java.util.List<ConversionMessage> |
+XmlPageWriter.getConversionInformation()
+Returns format conversion related messages
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static java.util.List<ConversionMessage> |
+ConverterHub.checkForCompliance(Page page,
+ org.primaresearch.io.FormatVersion targetVersion)
+Checks if the given page (layout) complies with specified target format.
+ |
+
java.util.List<ConversionMessage> |
+LayoutConverter.checkForCompliance(PageLayout layout)
+Checks if the given page layout is consistent to the target format version
+ of this converter.
+ |
+
java.util.List<ConversionMessage> |
+Converter_2013_07_15_to_2010_03_19.checkForCompliance(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2010_03_19_to_2010_01_12.checkForCompliance(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2010_01_12_to_2009_03_16.checkForCompliance(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+ChainConverter.checkForCompliance(PageLayout layout) |
+
static java.util.List<ConversionMessage> |
+ConverterHub.convert(Page page,
+ org.primaresearch.io.FormatModel targetModel)
+Converts the given page (layout) to the specified target format (might change attributes, attribute values and attribute constraints).
+ |
+
java.util.List<ConversionMessage> |
+LayoutConverter.convert(PageLayout layout)
+Converts the given page layout to the specified target format.
+ |
+
java.util.List<ConversionMessage> |
+Converter_2013_07_15_to_2010_03_19.convert(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2010_03_19_to_2010_01_12.convert(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2010_01_12_to_2009_03_16.convert(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+ChainConverter.convert(PageLayout layout) |
+
java.util.List<ConversionMessage> |
+Converter_2013_07_15_to_2010_03_19.run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
java.util.List<ConversionMessage> |
+Converter_2010_03_19_to_2010_01_12.run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
java.util.List<ConversionMessage> |
+Converter_2010_01_12_to_2009_03_16.run(PageLayout layout,
+ boolean checkOnly)
+Runs check or conversion
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ConverterHub.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ConverterHub.html new file mode 100644 index 00000000..d3a02c8b --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/ConverterHub.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.converter | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static ConverterHub |
+ConverterHub.getInstance()
+Returns singleton instance
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2010_01_12_to_2009_03_16.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2010_01_12_to_2009_03_16.html new file mode 100644 index 00000000..eb0b611c --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2010_01_12_to_2009_03_16.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2010_03_19_to_2010_01_12.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2010_03_19_to_2010_01_12.html new file mode 100644 index 00000000..4cbc12e4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2010_03_19_to_2010_01_12.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2013_07_15_to_2010_03_19.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2013_07_15_to_2010_03_19.html new file mode 100644 index 00000000..dc735920 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/Converter_2013_07_15_to_2010_03_19.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/LayoutConverter.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/LayoutConverter.html new file mode 100644 index 00000000..5ca388ba --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/class-use/LayoutConverter.html @@ -0,0 +1,208 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.converter | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ChainConverter
+Meta converter representing a chain of converters.
+ |
+
class |
+Converter_2010_01_12_to_2009_03_16
+Converter for 2010-01-12 format to 2009-03-16 format.
++ + + Adds temp region if there is no region (at least one region required) + |
+
class |
+Converter_2010_03_19_to_2010_01_12
+Converter for 2010-03-19 format to 2010-01-12 format.
++ + + Removes unsupported text types (signature-mark, catch-word, marginalia, footnote, footnote-continued, TOC-entry) + |
+
class |
+Converter_2013_07_15_to_2010_03_19
+Converter for 2013-07-15 format to 2010-03-19 format.
++ + + Removes unsupported graphic types (frame, barcode, decoration) + Removes unsupported text types (endnote, other) + Removes unsupported colours (other) + Removes unsupported languages + Converts unsupported regions to 'Unknown' (Music, Chem, Advert) + Removes unsupported attributes from regions, lines, words, and glyphs + |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ChainConverter.addConverter(LayoutConverter converter)
+Adds a converter to the chain
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-frame.html new file mode 100644 index 00000000..72ffefd8 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-frame.html @@ -0,0 +1,28 @@ + + + + + +| Interface | +Description | +
|---|---|
| LayoutConverter | +
+ Interface for converters that convert a page layout to comply with a certain format version.
+ |
+
| Class | +Description | +
|---|---|
| ChainConverter | +
+ Meta converter representing a chain of converters.
+ |
+
| ConversionMessage | +
+ Format conversion related message
+ |
+
| Converter_2010_01_12_to_2009_03_16 | +
+ Converter for 2010-01-12 format to 2009-03-16 format.
++ + + Adds temp region if there is no region (at least one region required) + |
+
| Converter_2010_03_19_to_2010_01_12 | +
+ Converter for 2010-03-19 format to 2010-01-12 format.
++ + + Removes unsupported text types (signature-mark, catch-word, marginalia, footnote, footnote-continued, TOC-entry) + |
+
| Converter_2013_07_15_to_2010_03_19 | +
+ Converter for 2013-07-15 format to 2010-03-19 format.
++ + + Removes unsupported graphic types (frame, barcode, decoration) + Removes unsupported text types (endnote, other) + Removes unsupported colours (other) + Removes unsupported languages + Converts unsupported regions to 'Unknown' (Music, Chem, Advert) + Removes unsupported attributes from regions, lines, words, and glyphs + |
+
| ConverterHub | +
+ Central access point for converting page objects to specific format versions.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-tree.html new file mode 100644 index 00000000..1c44f123 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-tree.html @@ -0,0 +1,138 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-use.html new file mode 100644 index 00000000..f0e660df --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/converter/package-use.html @@ -0,0 +1,203 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| org.primaresearch.dla.page.io.xml | ++ |
| org.primaresearch.dla.page.layout.converter | ++ |
| Class and Description | +
|---|
| ConversionMessage
+ Format conversion related message
+ |
+
| Class and Description | +
|---|
| ConversionMessage
+ Format conversion related message
+ |
+
| Class and Description | +
|---|
| ConversionMessage
+ Format conversion related message
+ |
+
| ConverterHub
+ Central access point for converting page objects to specific format versions.
+ |
+
| LayoutConverter
+ Interface for converters that convert a page layout to comply with a certain format version.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ContentObjectRelation.RelationType.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ContentObjectRelation.RelationType.html new file mode 100644 index 00000000..66cfd946 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ContentObjectRelation.RelationType.html @@ -0,0 +1,322 @@ + + + + + +public static class ContentObjectRelation.RelationType
+extends java.lang.Object
+| Modifier and Type | +Field and Description | +
|---|---|
static ContentObjectRelation.RelationType |
+Join
+Strong relation (e.g.
+ |
+
static ContentObjectRelation.RelationType |
+Link
+Weak relation (e.g.
+ |
+
static ContentObjectRelation.RelationType |
+ParentChildRelation
+Parent-child relation (e.g.
+ |
+
public static final ContentObjectRelation.RelationType ParentChildRelation+
public static final ContentObjectRelation.RelationType Link+
public static final ContentObjectRelation.RelationType Join+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ContentObjectRelation.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ContentObjectRelation.html new file mode 100644 index 00000000..bca13415 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ContentObjectRelation.html @@ -0,0 +1,381 @@ + + + + + +public class ContentObjectRelation
+extends java.lang.Object
+| Modifier and Type | +Class and Description | +
|---|---|
static class |
+ContentObjectRelation.RelationType
+Relation type for page content objects.
+ |
+
| Constructor and Description | +
|---|
ContentObjectRelation(ContentObject object1,
+ ContentObject object2,
+ ContentObjectRelation.RelationType relation)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getComments()
+Returns comments
+ |
+
java.lang.String |
+getCustomField()
+Returns custom content
+ |
+
ContentObject |
+getObject1() |
+
ContentObject |
+getObject2() |
+
ContentObjectRelation.RelationType |
+getRelationType() |
+
void |
+setComments(java.lang.String comments)
+Sets comments
+ |
+
void |
+setCustomField(java.lang.String customField)
+Sets custom content
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic ContentObjectRelation(ContentObject object1, + ContentObject object2, + ContentObjectRelation.RelationType relation)+
object1 - Page content object oneobject2 - Page content object tworelation - Relation between object one and object twopublic ContentObject getObject1()+
public ContentObject getObject2()+
public ContentObjectRelation.RelationType getRelationType()+
public java.lang.String getCustomField()+
public void setCustomField(java.lang.String customField)+
public java.lang.String getComments()+
public void setComments(java.lang.String comments)+
comments - Comments textCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Group.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Group.html new file mode 100644 index 00000000..d4890b9e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Group.html @@ -0,0 +1,541 @@ + + + + + +public class Group +extends java.lang.Object +implements GroupMember, org.primaresearch.ident.Identifiable+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+add(GroupMember member)
+Adds the given group member
+ |
+
void |
+addRegionRef(java.lang.String id)
+Adds a reference to a region as group member
+ |
+
boolean |
+containsRegionRef(org.primaresearch.ident.Id regionId)
+Recursively checks if this group or a child group contains a region reference with the given ID.
+ |
+
Group |
+createChildGroup()
+Creates a group and adds it as child to this group
+ |
+
boolean |
+delete(GroupMember member)
+Deletes a group member.
+ |
+
java.lang.String |
+getCaption()
+Returns the caption (display name)
+ |
+
org.primaresearch.ident.Id |
+getId() |
+
org.primaresearch.ident.IdRegister |
+getIdRegister() |
+
GroupMember |
+getMember(int index)
+Returns the group member at the given position
+ |
+
Group |
+getParent()
+Returns the parent of this group or
+null if it is a root group |
+
int |
+getSize()
+Returns the size of this group
+ |
+
boolean |
+isOrdered()
+Returns the 'ordered' state of this group
+ |
+
void |
+moveTo(Group newParent)
+Moves this object to another group
+ |
+
void |
+removeRegionRef(java.lang.String id)
+Removes a reference to a region
+ |
+
void |
+setCaption(java.lang.String caption)
+Sets the caption (display name)
+ |
+
void |
+setId(org.primaresearch.ident.Id id) |
+
void |
+setId(java.lang.String id) |
+
void |
+setOrdered(boolean ordered)
+Sets the 'ordered' state of this group
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic Group getParent()+
null if it is a root groupgetParent in interface GroupMemberpublic org.primaresearch.ident.Id getId()+
getId in interface org.primaresearch.ident.Identifiablepublic java.lang.String getCaption()+
public void setCaption(java.lang.String caption)+
public boolean isOrdered()+
true if an ordered group; false if an unordered grouppublic void setOrdered(boolean ordered)+
ordered - Set to true for an ordered group or false for an unordered grouppublic int getSize()+
public GroupMember getMember(int index)+
index - Positionpublic Group createChildGroup() + throws java.lang.Exception+
java.lang.Exception - The group is not allowed to have childrenpublic void addRegionRef(java.lang.String id)+
id - Region IDpublic void removeRegionRef(java.lang.String id)+
id - Region IDpublic boolean containsRegionRef(org.primaresearch.ident.Id regionId)+
regionId - ID of referenced regionpublic void add(GroupMember member)+
public org.primaresearch.ident.IdRegister getIdRegister()+
getIdRegister in interface org.primaresearch.ident.Identifiablepublic void setId(java.lang.String id) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
setId in interface org.primaresearch.ident.Identifiableorg.primaresearch.ident.IdRegister.InvalidIdExceptionpublic void setId(org.primaresearch.ident.Id id) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
setId in interface org.primaresearch.ident.Identifiableorg.primaresearch.ident.IdRegister.InvalidIdExceptionpublic void moveTo(Group newParent)+
GroupMembermoveTo in interface GroupMembernewParent - Target grouppublic boolean delete(GroupMember member)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/GroupMember.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/GroupMember.html new file mode 100644 index 00000000..219af7b9 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/GroupMember.html @@ -0,0 +1,234 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Layer.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Layer.html new file mode 100644 index 00000000..5f80c6e1 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Layer.html @@ -0,0 +1,261 @@ + + + + + +public class Layer +extends Group+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+getZIndex()
+Returns the z index of this layer (for ordering in z-dimension)
+ |
+
void |
+setZIndex(int zIndex)
+Sets the z index of this layer (for ordering in z-dimension)
+ |
+
add, addRegionRef, containsRegionRef, createChildGroup, delete, getCaption, getId, getIdRegister, getMember, getParent, getSize, isOrdered, moveTo, removeRegionRef, setCaption, setId, setId, setOrderedclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Layers.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Layers.html new file mode 100644 index 00000000..9c193b75 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Layers.html @@ -0,0 +1,305 @@ + + + + + +public class Layers
+extends java.lang.Object
+| Constructor and Description | +
|---|
Layers(PageLayout layout,
+ org.primaresearch.ident.IdRegister idRegister,
+ ContentFactory contentFactory)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Layer |
+createLayer()
+Creates and returns a new layer.
+ |
+
Layer |
+getLayer(int index)
+Returns the layer at the given index.
+ |
+
int |
+getSize()
+Returns the number of layers.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic Layers(PageLayout layout, + org.primaresearch.ident.IdRegister idRegister, + ContentFactory contentFactory)+
layout - Page layout which the layers are intended foridRegister - ID register (for creating layers)contentFactory - Content factory (for creating layers)public int getSize()+
public Layer getLayer(int index)+
java.lang.IndexOutOfBoundsExceptionpublic Layer createLayer()+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ReadingOrder.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ReadingOrder.html new file mode 100644 index 00000000..9540f3a5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/ReadingOrder.html @@ -0,0 +1,290 @@ + + + + + +public class ReadingOrder
+extends java.lang.Object
+| Constructor and Description | +
|---|
ReadingOrder(PageLayout layout,
+ org.primaresearch.ident.IdRegister idRegister,
+ ContentFactory contentFactory)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+contains(org.primaresearch.ident.Id regionId)
+Checks the the region with the given ID is referenced in the reading order.
+ |
+
Group |
+getRoot()
+Returns the root group (the reading order always has a root group)
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic ReadingOrder(PageLayout layout, + org.primaresearch.ident.IdRegister idRegister, + ContentFactory contentFactory)+
layout - Page layout the reading order is intended foridRegister - ID register (for creating groups)contentFactory - Content factory (for creating groups)public Group getRoot()+
public boolean contains(org.primaresearch.ident.Id regionId)+
regionId - ID of referenced regionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/RegionRef.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/RegionRef.html new file mode 100644 index 00000000..493815e4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/RegionRef.html @@ -0,0 +1,275 @@ + + + + + +public class RegionRef +extends java.lang.Object +implements GroupMember+
| Modifier and Type | +Method and Description | +
|---|---|
Group |
+getParent()
+Returns the parent group
+ |
+
org.primaresearch.ident.Id |
+getRegionId()
+Returns the ID of the referenced region
+ |
+
void |
+moveTo(Group newParent)
+Moves this group member to another group.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic org.primaresearch.ident.Id getRegionId()+
public Group getParent()+
GroupMembergetParent in interface GroupMemberpublic void moveTo(Group newParent)+
moveTo in interface GroupMembernewParent - Target groupCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Relations.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Relations.html new file mode 100644 index 00000000..8656920a --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/Relations.html @@ -0,0 +1,315 @@ + + + + + +public class Relations
+extends java.lang.Object
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+addRelation(ContentObjectRelation relation)
+Adds a relation to this container.
+ |
+
java.util.Set<ContentObjectRelation> |
+exportRelations()
+Exports a set of all relations.
+ |
+
ContentObjectRelation |
+getRelation(org.primaresearch.ident.Id id1,
+ org.primaresearch.ident.Id id2)
+Returns the relation for the objects with id1 and id2 or 'null', if no such relation exists.
+ |
+
boolean |
+isEmpty()
+Checks if there are relations in this container
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic boolean isEmpty()+
true if empty, false otherwisepublic void addRelation(ContentObjectRelation relation)+
relation - Relation object to addpublic ContentObjectRelation getRelation(org.primaresearch.ident.Id id1, + org.primaresearch.ident.Id id2)+
public java.util.Set<ContentObjectRelation> exportRelations()+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ContentObjectRelation.RelationType.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ContentObjectRelation.RelationType.html new file mode 100644 index 00000000..7d463df0 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ContentObjectRelation.RelationType.html @@ -0,0 +1,198 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.logical | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static ContentObjectRelation.RelationType |
+ContentObjectRelation.RelationType.Join
+Strong relation (e.g.
+ |
+
static ContentObjectRelation.RelationType |
+ContentObjectRelation.RelationType.Link
+Weak relation (e.g.
+ |
+
static ContentObjectRelation.RelationType |
+ContentObjectRelation.RelationType.ParentChildRelation
+Parent-child relation (e.g.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObjectRelation.RelationType |
+ContentObjectRelation.getRelationType() |
+
| Constructor and Description | +
|---|
ContentObjectRelation(ContentObject object1,
+ ContentObject object2,
+ ContentObjectRelation.RelationType relation)
+Constructor
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ContentObjectRelation.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ContentObjectRelation.html new file mode 100644 index 00000000..d9bc0fb8 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ContentObjectRelation.html @@ -0,0 +1,214 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ContentObjectRelation |
+PageLayout.getParentChildRelation(ContentType childType,
+ java.lang.String childId)
+Returns a parent-child relation object
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObjectRelation |
+Relations.getRelation(org.primaresearch.ident.Id id1,
+ org.primaresearch.ident.Id id2)
+Returns the relation for the objects with id1 and id2 or 'null', if no such relation exists.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.Set<ContentObjectRelation> |
+Relations.exportRelations()
+Exports a set of all relations.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Relations.addRelation(ContentObjectRelation relation)
+Adds a relation to this container.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Group.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Group.html new file mode 100644 index 00000000..5cd793ea --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Group.html @@ -0,0 +1,220 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.logical | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Layer
+Layer representing a group of regions with a specific z-index
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Group |
+Group.createChildGroup()
+Creates a group and adds it as child to this group
+ |
+
Group |
+RegionRef.getParent() |
+
Group |
+GroupMember.getParent()
+Returns the parent group
+ |
+
Group |
+Group.getParent()
+Returns the parent of this group or
+null if it is a root group |
+
Group |
+ReadingOrder.getRoot()
+Returns the root group (the reading order always has a root group)
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+RegionRef.moveTo(Group newParent)
+Moves this group member to another group.
+ |
+
void |
+GroupMember.moveTo(Group newParent)
+Moves this object to another group
+ |
+
void |
+Group.moveTo(Group newParent) |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/GroupMember.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/GroupMember.html new file mode 100644 index 00000000..a0e918c5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/GroupMember.html @@ -0,0 +1,206 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.logical | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Group
+A logical group within a page layout (e.g.
+ |
+
class |
+Layer
+Layer representing a group of regions with a specific z-index
+ |
+
class |
+RegionRef
+A group member pointing to an Identifiable object (e.g.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
GroupMember |
+Group.getMember(int index)
+Returns the group member at the given position
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Group.add(GroupMember member)
+Adds the given group member
+ |
+
boolean |
+Group.delete(GroupMember member)
+Deletes a group member.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Layer.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Layer.html new file mode 100644 index 00000000..88e9f1c8 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Layer.html @@ -0,0 +1,274 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ContentIterator |
+PageLayout.iterator(ContentType contentType,
+ Layer layer)
+Returns a new iterator for a specific page content type.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Layer |
+Layers.createLayer()
+Creates and returns a new layer.
+ |
+
Layer |
+Layers.getLayer(int index)
+Returns the layer at the given index.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Layer |
+ContentIterator.getLayer()
+Returns the layer this iterator is restricted to (no
+null for no restriction) |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected Layer |
+RegionIterator.layer |
+
| Modifier and Type | +Method and Description | +
|---|---|
Layer |
+RegionIterator.getLayer() |
+
Layer |
+LowLevelTextObjectIterator.getLayer() |
+
| Constructor and Description | +
|---|
LowLevelTextObjectIterator(PageLayout pageLayout,
+ LowLevelTextType contentType,
+ Layer layer)
+Constructor
+ |
+
RegionIterator(PageLayout pageLayout,
+ RegionType contentType,
+ Layer layer)
+Constructor
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Layers.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Layers.html new file mode 100644 index 00000000..22351abd --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Layers.html @@ -0,0 +1,188 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Layers |
+PageLayout.createLayers()
+Creates and returns a new layers object for the layout.
+ |
+
Layers |
+PageLayout.getLayers()
+Returns the layers of the layout.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Layers |
+ContentFactory.createLayers(PageLayout layout)
+Creates a layer container
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ReadingOrder.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ReadingOrder.html new file mode 100644 index 00000000..24aec128 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/ReadingOrder.html @@ -0,0 +1,188 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ReadingOrder |
+PageLayout.createReadingOrder()
+Creates and returns a new reading order for the layout.
+ |
+
ReadingOrder |
+PageLayout.getReadingOrder()
+Returns the reading order of the layout.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ReadingOrder |
+ContentFactory.createReadingOrder(PageLayout layout)
+Creates a reading order object
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/RegionRef.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/RegionRef.html new file mode 100644 index 00000000..fc46d4e5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/RegionRef.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Relations.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Relations.html new file mode 100644 index 00000000..19f81a87 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/class-use/Relations.html @@ -0,0 +1,158 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Relations |
+PageLayout.getRelations()
+Returns the container for all relations between regions.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-frame.html new file mode 100644 index 00000000..658c653d --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-frame.html @@ -0,0 +1,30 @@ + + + + + +| Interface | +Description | +
|---|---|
| GroupMember | +
+ A member of a logical layout group.
+ |
+
| Class | +Description | +
|---|---|
| ContentObjectRelation | +
+ Represents a relation between two page content objects (e.g.
+ |
+
| ContentObjectRelation.RelationType | +
+ Relation type for page content objects.
+ |
+
| Group | +
+ A logical group within a page layout (e.g.
+ |
+
| Layer | +
+ Layer representing a group of regions with a specific z-index
+ |
+
| Layers | +
+ Container class for logical layers that can contain layout regions.
+ |
+
| ReadingOrder | +
+ Class for logical reading order of layout regions.
+ |
+
| RegionRef | +
+ A group member pointing to an Identifiable object (e.g.
+ |
+
| Relations | +
+ Container class for relations between content objects.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-tree.html new file mode 100644 index 00000000..e9dfc960 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-tree.html @@ -0,0 +1,143 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-use.html new file mode 100644 index 00000000..4f7a16c5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/logical/package-use.html @@ -0,0 +1,264 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| Class and Description | +
|---|
| ContentObjectRelation
+ Represents a relation between two page content objects (e.g.
+ |
+
| Layer
+ Layer representing a group of regions with a specific z-index
+ |
+
| Layers
+ Container class for logical layers that can contain layout regions.
+ |
+
| ReadingOrder
+ Class for logical reading order of layout regions.
+ |
+
| Relations
+ Container class for relations between content objects.
+ |
+
| Class and Description | +
|---|
| ContentObjectRelation
+ Represents a relation between two page content objects (e.g.
+ |
+
| ContentObjectRelation.RelationType
+ Relation type for page content objects.
+ |
+
| Group
+ A logical group within a page layout (e.g.
+ |
+
| GroupMember
+ A member of a logical layout group.
+ |
+
| Layer
+ Layer representing a group of regions with a specific z-index
+ |
+
| Class and Description | +
|---|
| Layer
+ Layer representing a group of regions with a specific z-index
+ |
+
| Layers
+ Container class for logical layers that can contain layout regions.
+ |
+
| ReadingOrder
+ Class for logical reading order of layout regions.
+ |
+
| Class and Description | +
|---|
| Layer
+ Layer representing a group of regions with a specific z-index
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-frame.html new file mode 100644 index 00000000..5bf20f44 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-frame.html @@ -0,0 +1,21 @@ + + + + + +| Class | +Description | +
|---|---|
| GeometricObjectImpl | +
+ Basic implementation of an object that can be located on the document page.
+ |
+
| GeometricObjectPositionComparator | +
+ Comparator to sort geometric objects by bounding box position (left or top).
+ |
+
| PageLayout | +
+ Class representing the layout and text content of a document page.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-tree.html new file mode 100644 index 00000000..56fff5eb --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-tree.html @@ -0,0 +1,131 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-use.html new file mode 100644 index 00000000..d974f543 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/package-use.html @@ -0,0 +1,256 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.converter | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| Class and Description | +
|---|
| PageLayout
+ Class representing the layout and text content of a document page.
+ |
+
| Class and Description | +
|---|
| GeometricObjectPositionComparator
+ Comparator to sort geometric objects by bounding box position (left or top).
+ |
+
| Class and Description | +
|---|
| PageLayout
+ Class representing the layout and text content of a document page.
+ |
+
| Class and Description | +
|---|
| PageLayout
+ Class representing the layout and text content of a document page.
+ |
+
| Class and Description | +
|---|
| PageLayout
+ Class representing the layout and text content of a document page.
+ |
+
| Class and Description | +
|---|
| PageLayout
+ Class representing the layout and text content of a document page.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/AttributeContainer.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/AttributeContainer.html new file mode 100644 index 00000000..354597b9 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/AttributeContainer.html @@ -0,0 +1,222 @@ + + + + + +public interface AttributeContainer
+| Modifier and Type | +Method and Description | +
|---|---|
org.primaresearch.shared.variable.VariableMap |
+getAttributes()
+Returns the attributes of the object.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/AttributeFactory.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/AttributeFactory.html new file mode 100644 index 00000000..f5aa25de --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/AttributeFactory.html @@ -0,0 +1,219 @@ + + + + + +public interface AttributeFactory
+| Modifier and Type | +Method and Description | +
|---|---|
org.primaresearch.shared.variable.VariableMap |
+createAttributes(ContentType type)
+Returns a collection of attributes suitable for content objects of the given type.
+ |
+
org.primaresearch.shared.variable.VariableMap createAttributes(ContentType type)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentFactory.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentFactory.html new file mode 100644 index 00000000..23de19ba --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentFactory.html @@ -0,0 +1,360 @@ + + + + + +public class ContentFactory
+extends java.lang.Object
+| Constructor and Description | +
|---|
ContentFactory(org.primaresearch.ident.IdRegister idRegister,
+ AttributeFactory attributeFactory)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+createContent(ContentType type)
+Creates a new content object of the given type
+ |
+
Layers |
+createLayers(PageLayout layout)
+Creates a layer container
+ |
+
ReadingOrder |
+createReadingOrder(PageLayout layout)
+Creates a reading order object
+ |
+
org.primaresearch.ident.IdRegister |
+getIdRegister()
+Sets the ID register that is used for creating new objects
+ |
+
org.primaresearch.ident.Id |
+registerNewId(java.lang.String id)
+Registers the specified ID
+ |
+
void |
+setAttributeFactory(AttributeFactory factory)
+Sets the attribute factory that is used for creating attributes for new objects
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic ContentFactory(org.primaresearch.ident.IdRegister idRegister, + AttributeFactory attributeFactory)+
idRegister - ID register to guarantee unique content object IDsattributeFactory - Factory for object attributespublic ContentObject createContent(ContentType type)+
type - Content type (e.g. text region)null if the type is not supportedpublic ReadingOrder createReadingOrder(PageLayout layout)+
layout - Page layout the reading order is intended forpublic Layers createLayers(PageLayout layout)+
layout - Page layout the layer container is intended forpublic org.primaresearch.ident.Id registerNewId(java.lang.String id) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
id - ID contentorg.primaresearch.ident.IdRegister.InvalidIdException - ID invalidpublic void setAttributeFactory(AttributeFactory factory)+
public org.primaresearch.ident.IdRegister getIdRegister()+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentIterator.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentIterator.html new file mode 100644 index 00000000..3f392005 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentIterator.html @@ -0,0 +1,265 @@ + + + + + +public interface ContentIterator
+| Modifier and Type | +Method and Description | +
|---|---|
ContentType |
+getContentType()
+Returns the content type of the page content objects this iterator was created for.
+ |
+
Layer |
+getLayer()
+Returns the layer this iterator is restricted to (no
+null for no restriction) |
+
boolean |
+hasNext()
+Is there another page content object?
+ |
+
ContentObject |
+next()
+Progresses the iterator and returns the next page content object.
+ |
+
boolean hasNext()+
ContentObject next()+
ContentType getContentType()+
Layer getLayer()+
null for no restriction)Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentObject.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentObject.html new file mode 100644 index 00000000..3b991e69 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentObject.html @@ -0,0 +1,304 @@ + + + + + +public interface ContentObject +extends AttributeContainer, org.primaresearch.ident.Identifiable, GeometricObject+
| Modifier and Type | +Field and Description | +
|---|---|
static java.lang.String |
+TEMP_ID_SUFFIX
+Suffix used for IDs of temporary content objects
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentType |
+getType()
+Returns the type of this page content object
+ |
+
boolean |
+isTemporary()
+Checks if this is a temporary content object
+ |
+
getAttributesgetId, getIdRegister, setId, setIdgetCoords, setCoordsstatic final java.lang.String TEMP_ID_SUFFIX+
ContentType getType()+
boolean isTemporary()+
true if temporary, false if normal content objectCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentObjectProcessor.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentObjectProcessor.html new file mode 100644 index 00000000..d959c45c --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/ContentObjectProcessor.html @@ -0,0 +1,327 @@ + + + + + +public abstract class ContentObjectProcessor
+extends java.lang.Object
+| Constructor and Description | +
|---|
ContentObjectProcessor() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract void |
+doProcess(ContentObject contentObject)
+Called for each content object.
+ |
+
ContentObject |
+getCurrentObject()
+Returns the content object that is currently processed.
+ |
+
boolean |
+isIncludeLowLevelTextObjects()
+Flag to set if text lines, words, and glyphs should be included or not
+ |
+
void |
+run(Page page)
+Run the processor.
+ |
+
void |
+setIncludeLowLevelTextObjects(boolean includeLowLevelTextObjects)
+Flag to set if text lines, words, and glyphs should be included or not
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic ContentObjectProcessor()+
public abstract void doProcess(ContentObject contentObject)+
public ContentObject getCurrentObject()+
public void run(Page page)+
public boolean isIncludeLowLevelTextObjects()+
public void setIncludeLowLevelTextObjects(boolean includeLowLevelTextObjects)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/DefaultAttributeFactory.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/DefaultAttributeFactory.html new file mode 100644 index 00000000..57576dde --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/DefaultAttributeFactory.html @@ -0,0 +1,294 @@ + + + + + +public class DefaultAttributeFactory +extends java.lang.Object +implements AttributeFactory+
| Constructor and Description | +
|---|
DefaultAttributeFactory()
+Constructor for static use
+ |
+
DefaultAttributeFactory(org.primaresearch.io.FormatModel schemaParser)
+Constructor for dynamic use.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
org.primaresearch.shared.variable.VariableMap |
+createAttributes(ContentType type)
+Returns a collection of attributes suitable for content objects of the given type.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic DefaultAttributeFactory()+
public DefaultAttributeFactory(org.primaresearch.io.FormatModel schemaParser)+
schemaParser - Parser for XML schemapublic org.primaresearch.shared.variable.VariableMap createAttributes(ContentType type)+
AttributeFactorycreateAttributes in interface AttributeFactoryCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/Region.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/Region.html new file mode 100644 index 00000000..5c0b0cbd --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/Region.html @@ -0,0 +1,272 @@ + + + + + +public interface Region +extends ContentObject, RegionContainer+
TEMP_ID_SUFFIX| Modifier and Type | +Method and Description | +
|---|---|
RegionContainer |
+getParentRegion()
+Returns the parent region if this is a nested region or
+null if it has no parent |
+
getType, isTemporarygetAttributesgetId, getIdRegister, setId, setIdgetCoords, setCoordsaddRegion, getRegion, getRegionCount, hasRegions, removeRegionRegionContainer getParentRegion()+
null if it has no parentCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/RegionContainer.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/RegionContainer.html new file mode 100644 index 00000000..d8b31a58 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/RegionContainer.html @@ -0,0 +1,290 @@ + + + + + +public interface RegionContainer
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+addRegion(Region region)
+Adds a nested region
+ |
+
Region |
+getRegion(int index)
+Returns a nested region
+ |
+
int |
+getRegionCount()
+Returns the number of regions that are nested within this object
+ |
+
boolean |
+hasRegions()
+Checks if this object contains nested regions
+ |
+
void |
+removeRegion(Region region)
+Removes a nested region
+ |
+
boolean hasRegions()+
true if there are nested regions, false otherwiseint getRegionCount()+
Region getRegion(int index)+
index - Positionvoid addRegion(Region region)+
region - Region to addvoid removeRegion(Region region)+
region - Region to removeCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/AttributeContainer.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/AttributeContainer.html new file mode 100644 index 00000000..8f9ac5fe --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/AttributeContainer.html @@ -0,0 +1,350 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Page
+Central class representing one page of a document (e.g.
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+ContentObject
+Represents physical page content objects (e.g.
+ |
+
interface |
+Region
+Layout region
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdvertRegion
+Specialised implementation for advert regions.
+ |
+
class |
+ChartRegion
+Specialised implementation for chart regions.
+ |
+
class |
+ChemRegion
+Specialised implementation for chemical formula regions.
+ |
+
class |
+FrameRegion
+Specialised implementation for frame regions.
+ |
+
class |
+GraphicRegion
+Specialised implementation for graphic regions.
+ |
+
class |
+ImageRegion
+Specialised implementation for image regions.
+ |
+
class |
+LineDrawingRegion
+Specialised implementation for line drawing regions.
+ |
+
class |
+MathsRegion
+Specialised implementation for maths regions.
+ |
+
class |
+MusicRegion
+Specialised implementation for musical notation regions.
+ |
+
class |
+NoiseRegion
+Specialised implementation for noise regions.
+ |
+
class |
+RegionImpl
+Basic implementation for layout regions.
+ |
+
class |
+SeparatorRegion
+Specialised implementation for separator regions.
+ |
+
class |
+TableRegion
+Specialised implementation for table regions.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LowLevelTextObject
+Abstract class representing low level text objects such as text line, word and glyph.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Glyph
+Specialised low level text object representing glyphs within a page layout.
+ |
+
class |
+TextLine
+Specialised low level text object representing text lines within a page layout.
+ |
+
class |
+TextRegion
+Specialised layout region for text.
+ |
+
class |
+Word
+Specialised low level text object representing words within a page layout.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/AttributeFactory.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/AttributeFactory.html new file mode 100644 index 00000000..320d217e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/AttributeFactory.html @@ -0,0 +1,189 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+DefaultAttributeFactory
+Attribute factory for the default layout content types of PAGE (static/dynamic).
++ + In static mode types and attributes are hard coded. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ContentFactory.setAttributeFactory(AttributeFactory factory)
+Sets the attribute factory that is used for creating attributes for new objects
+ |
+
| Constructor and Description | +
|---|
ContentFactory(org.primaresearch.ident.IdRegister idRegister,
+ AttributeFactory attributeFactory)
+Constructor
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentFactory.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentFactory.html new file mode 100644 index 00000000..4f026950 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentFactory.html @@ -0,0 +1,228 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Constructor and Description | +
|---|
PageLayout(ContentFactory contentFactory)
+Constructor
+ |
+
| Constructor and Description | +
|---|
Layers(PageLayout layout,
+ org.primaresearch.ident.IdRegister idRegister,
+ ContentFactory contentFactory)
+Constructor
+ |
+
ReadingOrder(PageLayout layout,
+ org.primaresearch.ident.IdRegister idRegister,
+ ContentFactory contentFactory)
+Constructor
+ |
+
| Constructor and Description | +
|---|
TextLine(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parentRegion) |
+
TextRegion(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
Word(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parentLine) |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentIterator.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentIterator.html new file mode 100644 index 00000000..19ebf69a --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentIterator.html @@ -0,0 +1,195 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ContentIterator |
+PageLayout.iterator(ContentType contentType)
+Returns a new iterator for a specific page content type.
+ |
+
ContentIterator |
+PageLayout.iterator(ContentType contentType,
+ Layer layer)
+Returns a new iterator for a specific page content type.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LowLevelTextObjectIterator
+Page content object iterator implementation for low level text objects (text lines, words, and glyphs).
+ |
+
class |
+RegionIterator
+Page content object iterator implementation for regions (zones/blocks).
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentObject.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentObject.html new file mode 100644 index 00000000..91d9013e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentObject.html @@ -0,0 +1,476 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+PageLayout.changeTypeOfRegion(ContentObject region,
+ RegionType newType)
+Creates a region object with the id of the given object and the new region type.
+ |
+
ContentObject |
+PageLayout.getObject(ContentType type,
+ java.lang.String id)
+Returns the content object of given type and ID
+ |
+
ContentObject |
+PageLayout.getObjectAt(int x,
+ int y,
+ ContentType type)
+Looks for a content object of a specific type at the given position within the document page.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+PageLayout.changeTypeOfRegion(ContentObject region,
+ RegionType newType)
+Creates a region object with the id of the given object and the new region type.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+ContentObjectRelation.getObject1() |
+
ContentObject |
+ContentObjectRelation.getObject2() |
+
| Constructor and Description | +
|---|
ContentObjectRelation(ContentObject object1,
+ ContentObject object2,
+ ContentObjectRelation.RelationType relation)
+Constructor
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+Region
+Layout region
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+ContentFactory.createContent(ContentType type)
+Creates a new content object of the given type
+ |
+
ContentObject |
+ContentObjectProcessor.getCurrentObject()
+Returns the content object that is currently processed.
+ |
+
ContentObject |
+ContentIterator.next()
+Progresses the iterator and returns the next page content object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract void |
+ContentObjectProcessor.doProcess(ContentObject contentObject)
+Called for each content object.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdvertRegion
+Specialised implementation for advert regions.
+ |
+
class |
+ChartRegion
+Specialised implementation for chart regions.
+ |
+
class |
+ChemRegion
+Specialised implementation for chemical formula regions.
+ |
+
class |
+FrameRegion
+Specialised implementation for frame regions.
+ |
+
class |
+GraphicRegion
+Specialised implementation for graphic regions.
+ |
+
class |
+ImageRegion
+Specialised implementation for image regions.
+ |
+
class |
+LineDrawingRegion
+Specialised implementation for line drawing regions.
+ |
+
class |
+MathsRegion
+Specialised implementation for maths regions.
+ |
+
class |
+MusicRegion
+Specialised implementation for musical notation regions.
+ |
+
class |
+NoiseRegion
+Specialised implementation for noise regions.
+ |
+
class |
+RegionImpl
+Basic implementation for layout regions.
+ |
+
class |
+SeparatorRegion
+Specialised implementation for separator regions.
+ |
+
class |
+TableRegion
+Specialised implementation for table regions.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+RegionIterator.next() |
+
ContentObject |
+LowLevelTextObjectIterator.next() |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LowLevelTextObject
+Abstract class representing low level text objects such as text line, word and glyph.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Glyph
+Specialised low level text object representing glyphs within a page layout.
+ |
+
class |
+TextLine
+Specialised low level text object representing text lines within a page layout.
+ |
+
class |
+TextRegion
+Specialised layout region for text.
+ |
+
class |
+Word
+Specialised low level text object representing words within a page layout.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentObjectProcessor.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentObjectProcessor.html new file mode 100644 index 00000000..005a6ab3 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/ContentObjectProcessor.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/DefaultAttributeFactory.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/DefaultAttributeFactory.html new file mode 100644 index 00000000..7029b92c --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/DefaultAttributeFactory.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/Region.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/Region.html new file mode 100644 index 00000000..10478324 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/Region.html @@ -0,0 +1,408 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Region |
+PageLayout.createRegion(RegionType type)
+Creates a region of the specified type.
+ |
+
Region |
+PageLayout.createRegion(RegionType type,
+ java.lang.String id)
+Creates a region of the specified type.
+ |
+
Region |
+PageLayout.createRegion(RegionType type,
+ java.lang.String id,
+ RegionContainer parentRegion)
+Creates a region of the specified type.
+ |
+
Region |
+PageLayout.getRegion(org.primaresearch.ident.Id regionId)
+Returns the region with the given ID.
+ |
+
Region |
+PageLayout.getRegion(int index)
+Returns the region at the specified index.
+ |
+
Region |
+PageLayout.getRegion(java.lang.String regionId)
+Returns the region with the given ID.
+ |
+
Region |
+PageLayout.getRegionAt(int x,
+ int y)
+Looks for a region at the given position within the document page.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<Region> |
+PageLayout.getRegionsSorted()
+Returns a sorted list of all regions.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Region |
+RegionContainer.getRegion(int index)
+Returns a nested region
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+RegionContainer.addRegion(Region region)
+Adds a nested region
+ |
+
void |
+RegionContainer.removeRegion(Region region)
+Removes a nested region
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdvertRegion
+Specialised implementation for advert regions.
+ |
+
class |
+ChartRegion
+Specialised implementation for chart regions.
+ |
+
class |
+ChemRegion
+Specialised implementation for chemical formula regions.
+ |
+
class |
+FrameRegion
+Specialised implementation for frame regions.
+ |
+
class |
+GraphicRegion
+Specialised implementation for graphic regions.
+ |
+
class |
+ImageRegion
+Specialised implementation for image regions.
+ |
+
class |
+LineDrawingRegion
+Specialised implementation for line drawing regions.
+ |
+
class |
+MathsRegion
+Specialised implementation for maths regions.
+ |
+
class |
+MusicRegion
+Specialised implementation for musical notation regions.
+ |
+
class |
+NoiseRegion
+Specialised implementation for noise regions.
+ |
+
class |
+RegionImpl
+Basic implementation for layout regions.
+ |
+
class |
+SeparatorRegion
+Specialised implementation for separator regions.
+ |
+
class |
+TableRegion
+Specialised implementation for table regions.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Region |
+RegionImpl.getRegion(int index) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+RegionImpl.addRegion(Region region) |
+
void |
+RegionImpl.removeRegion(Region region) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TextRegion
+Specialised layout region for text.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/RegionContainer.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/RegionContainer.html new file mode 100644 index 00000000..370f0074 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/class-use/RegionContainer.html @@ -0,0 +1,462 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Region |
+PageLayout.createRegion(RegionType type,
+ java.lang.String id,
+ RegionContainer parentRegion)
+Creates a region of the specified type.
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+Region
+Layout region
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RegionContainer |
+Region.getParentRegion()
+Returns the parent region if this is a nested region or
+null if it has no parent |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdvertRegion
+Specialised implementation for advert regions.
+ |
+
class |
+ChartRegion
+Specialised implementation for chart regions.
+ |
+
class |
+ChemRegion
+Specialised implementation for chemical formula regions.
+ |
+
class |
+FrameRegion
+Specialised implementation for frame regions.
+ |
+
class |
+GraphicRegion
+Specialised implementation for graphic regions.
+ |
+
class |
+ImageRegion
+Specialised implementation for image regions.
+ |
+
class |
+LineDrawingRegion
+Specialised implementation for line drawing regions.
+ |
+
class |
+MathsRegion
+Specialised implementation for maths regions.
+ |
+
class |
+MusicRegion
+Specialised implementation for musical notation regions.
+ |
+
class |
+NoiseRegion
+Specialised implementation for noise regions.
+ |
+
class |
+RegionImpl
+Basic implementation for layout regions.
+ |
+
class |
+SeparatorRegion
+Specialised implementation for separator regions.
+ |
+
class |
+TableRegion
+Specialised implementation for table regions.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RegionContainer |
+RegionImpl.getParentRegion() |
+
| Constructor and Description | +
|---|
AdvertRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
ChartRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
ChemRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
FrameRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
GraphicRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
ImageRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
LineDrawingRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
MathsRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
MusicRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
NoiseRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
RegionImpl(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion)
+Constructor
+ |
+
SeparatorRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
TableRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TextRegion
+Specialised layout region for text.
+ |
+
| Constructor and Description | +
|---|
TextRegion(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/AdvertRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/AdvertRegion.html new file mode 100644 index 00000000..f34539ca --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/AdvertRegion.html @@ -0,0 +1,341 @@ + + + + + +public class AdvertRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
AdvertRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
double |
+getOrientation() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic AdvertRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public double getOrientation()+
public void setOrientation(double orientation)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ChartRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ChartRegion.html new file mode 100644 index 00000000..c5c5c9b4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ChartRegion.html @@ -0,0 +1,419 @@ + + + + + +public class ChartRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
ChartRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
java.lang.String |
+getChartType() |
+
int |
+getNumColours() |
+
double |
+getOrientation() |
+
boolean |
+hasEmbeddedText() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setChartType(java.lang.String type) |
+
void |
+setEmbeddedText(boolean hasText) |
+
void |
+setNumColours(int num) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic ChartRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getChartType()+
public void setChartType(java.lang.String type)+
public int getNumColours()+
public void setNumColours(int num)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public double getOrientation()+
public void setOrientation(double orientation)+
public boolean hasEmbeddedText()+
public void setEmbeddedText(boolean hasText)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ChemRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ChemRegion.html new file mode 100644 index 00000000..f7ee2135 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ChemRegion.html @@ -0,0 +1,341 @@ + + + + + +public class ChemRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
ChemRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
double |
+getOrientation() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic ChemRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public double getOrientation()+
public void setOrientation(double orientation)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/FrameRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/FrameRegion.html new file mode 100644 index 00000000..89b1479c --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/FrameRegion.html @@ -0,0 +1,341 @@ + + + + + +public class FrameRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
FrameRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
boolean |
+isBorderPresent() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setBorderPresent(boolean border) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic FrameRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public boolean isBorderPresent()+
public void setBorderPresent(boolean border)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/GraphicRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/GraphicRegion.html new file mode 100644 index 00000000..287fe584 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/GraphicRegion.html @@ -0,0 +1,393 @@ + + + + + +public class GraphicRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
GraphicRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getGraphicType() |
+
int |
+getNumColours() |
+
double |
+getOrientation() |
+
boolean |
+hasEmbeddedText() |
+
void |
+setEmbeddedText(boolean hasText) |
+
void |
+setGraphicType(java.lang.String type) |
+
void |
+setNumColours(int num) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic GraphicRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getGraphicType()+
public void setGraphicType(java.lang.String type)+
public int getNumColours()+
public void setNumColours(int num)+
public double getOrientation()+
public void setOrientation(double orientation)+
public boolean hasEmbeddedText()+
public void setEmbeddedText(boolean hasText)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ImageRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ImageRegion.html new file mode 100644 index 00000000..6cc9be2b --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/ImageRegion.html @@ -0,0 +1,393 @@ + + + + + +public class ImageRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
ImageRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
java.lang.String |
+getColourDepth() |
+
double |
+getOrientation() |
+
boolean |
+hasEmbeddedText() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setColourDepth(java.lang.String colourDepth) |
+
void |
+setEmbeddedText(boolean hasText) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic ImageRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getColourDepth()+
public void setColourDepth(java.lang.String colourDepth)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public double getOrientation()+
public void setOrientation(double orientation)+
public boolean hasEmbeddedText()+
public void setEmbeddedText(boolean hasText)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/LineDrawingRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/LineDrawingRegion.html new file mode 100644 index 00000000..c21cb88d --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/LineDrawingRegion.html @@ -0,0 +1,393 @@ + + + + + +public class LineDrawingRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
LineDrawingRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
double |
+getOrientation() |
+
java.lang.String |
+getPenColour() |
+
boolean |
+hasEmbeddedText() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setEmbeddedText(boolean hasText) |
+
void |
+setOrientation(double orientation) |
+
void |
+setPenColour(java.lang.String colour) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic LineDrawingRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getPenColour()+
public void setPenColour(java.lang.String colour)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public double getOrientation()+
public void setOrientation(double orientation)+
public boolean hasEmbeddedText()+
public void setEmbeddedText(boolean hasText)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/LowLevelTextObjectIterator.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/LowLevelTextObjectIterator.html new file mode 100644 index 00000000..5344d524 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/LowLevelTextObjectIterator.html @@ -0,0 +1,344 @@ + + + + + +public class LowLevelTextObjectIterator +extends java.lang.Object +implements ContentIterator+
| Constructor and Description | +
|---|
LowLevelTextObjectIterator(PageLayout pageLayout,
+ LowLevelTextType contentType,
+ Layer layer)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentType |
+getContentType()
+Returns the content type of the page content objects this iterator was created for.
+ |
+
Layer |
+getLayer()
+Returns the layer this iterator is restricted to (no
+null for no restriction) |
+
boolean |
+hasNext()
+Is there another page content object?
+ |
+
ContentObject |
+next()
+Progresses the iterator and returns the next page content object.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic LowLevelTextObjectIterator(PageLayout pageLayout, + LowLevelTextType contentType, + Layer layer)+
contentType - Low level text object type (text line, word, or glyph)layer - Restrict the iterator to this layer (use null for no restriction)public boolean hasNext()+
ContentIteratorhasNext in interface ContentIteratorpublic ContentObject next()+
ContentIteratornext in interface ContentIteratorpublic ContentType getContentType()+
ContentIteratorgetContentType in interface ContentIteratorpublic Layer getLayer()+
ContentIteratornull for no restriction)getLayer in interface ContentIteratorCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/MathsRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/MathsRegion.html new file mode 100644 index 00000000..5c33c177 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/MathsRegion.html @@ -0,0 +1,341 @@ + + + + + +public class MathsRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
MathsRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
double |
+getOrientation() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic MathsRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public double getOrientation()+
public void setOrientation(double orientation)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/MusicRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/MusicRegion.html new file mode 100644 index 00000000..3493e5da --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/MusicRegion.html @@ -0,0 +1,341 @@ + + + + + +public class MusicRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
MusicRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
double |
+getOrientation() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic MusicRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public double getOrientation()+
public void setOrientation(double orientation)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/NoiseRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/NoiseRegion.html new file mode 100644 index 00000000..70675793 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/NoiseRegion.html @@ -0,0 +1,273 @@ + + + + + +public class NoiseRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
NoiseRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic NoiseRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/RegionImpl.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/RegionImpl.html new file mode 100644 index 00000000..0ce3dc72 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/RegionImpl.html @@ -0,0 +1,591 @@ + + + + + +public abstract class RegionImpl +extends java.lang.Object +implements Region+
TEMP_ID_SUFFIX| Modifier | +Constructor and Description | +
|---|---|
protected |
+RegionImpl(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addRegion(Region region)
+Adds a nested region
+ |
+
org.primaresearch.shared.variable.VariableMap |
+getAttributes()
+Returns the attributes of the object.
+ |
+
org.primaresearch.maths.geometry.Polygon |
+getCoords()
+Returns the location of the object.
+ |
+
org.primaresearch.ident.Id |
+getId() |
+
org.primaresearch.ident.IdRegister |
+getIdRegister() |
+
RegionContainer |
+getParentRegion()
+Returns the parent region if this is a nested region or
+null if it has no parent |
+
Region |
+getRegion(int index)
+Returns a nested region
+ |
+
int |
+getRegionCount()
+Returns the number of regions that are nested within this object
+ |
+
ContentType |
+getType()
+Returns the type of this page content object
+ |
+
boolean |
+hasRegions()
+Checks if this object contains nested regions
+ |
+
boolean |
+isTemporary()
+Checks if this is a temporary content object
+ |
+
void |
+removeRegion(Region region)
+Removes a nested region
+ |
+
void |
+setCoords(org.primaresearch.maths.geometry.Polygon coords)
+Sets the location of the object
+ |
+
void |
+setId(org.primaresearch.ident.Id id) |
+
void |
+setId(java.lang.String id) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected RegionImpl(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
idRegister - ID register (for creating child objects)type - Region typeid - Region IDcoords - Region outlineattributes - Region attributesparentRegion - (optional) Parent regionpublic ContentType getType()+
ContentObjectgetType in interface ContentObjectpublic boolean hasRegions()+
RegionContainerhasRegions in interface RegionContainertrue if there are nested regions, false otherwisepublic int getRegionCount()+
RegionContainergetRegionCount in interface RegionContainerpublic Region getRegion(int index)+
RegionContainergetRegion in interface RegionContainerindex - Positionpublic RegionContainer getParentRegion()+
Regionnull if it has no parentgetParentRegion in interface Regionpublic org.primaresearch.shared.variable.VariableMap getAttributes()+
AttributeContainergetAttributes in interface AttributeContainerpublic org.primaresearch.maths.geometry.Polygon getCoords()+
GeometricObjectgetCoords in interface GeometricObjectpublic void setCoords(org.primaresearch.maths.geometry.Polygon coords)+
GeometricObjectsetCoords in interface GeometricObjectcoords - A polygonpublic org.primaresearch.ident.Id getId()+
getId in interface org.primaresearch.ident.Identifiablepublic org.primaresearch.ident.IdRegister getIdRegister()+
getIdRegister in interface org.primaresearch.ident.Identifiablepublic void setId(java.lang.String id) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
setId in interface org.primaresearch.ident.Identifiableorg.primaresearch.ident.IdRegister.InvalidIdExceptionpublic void setId(org.primaresearch.ident.Id id) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
setId in interface org.primaresearch.ident.Identifiableorg.primaresearch.ident.IdRegister.InvalidIdExceptionpublic boolean isTemporary()+
ContentObjectisTemporary in interface ContentObjecttrue if temporary, false if normal content objectpublic void addRegion(Region region)+
RegionContaineraddRegion in interface RegionContainerregion - Region to addpublic void removeRegion(Region region)+
RegionContainerremoveRegion in interface RegionContainerregion - Region to removeCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/RegionIterator.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/RegionIterator.html new file mode 100644 index 00000000..5a56a261 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/RegionIterator.html @@ -0,0 +1,432 @@ + + + + + +public class RegionIterator +extends java.lang.Object +implements ContentIterator+
| Modifier and Type | +Field and Description | +
|---|---|
protected RegionType |
+contentType |
+
protected org.primaresearch.dla.page.layout.physical.impl.RegionIterator.NestedRegionIterator |
+currentNestedRegionIterator |
+
protected int |
+index |
+
protected Layer |
+layer |
+
protected PageLayout |
+pageLayout |
+
| Constructor and Description | +
|---|
RegionIterator(PageLayout pageLayout,
+ RegionType contentType,
+ Layer layer)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentType |
+getContentType()
+Returns the content type of the page content objects this iterator was created for.
+ |
+
Layer |
+getLayer()
+Returns the layer this iterator is restricted to (no
+null for no restriction) |
+
boolean |
+hasNext()
+Is there another page content object?
+ |
+
ContentObject |
+next()
+Progresses the iterator and returns the next page content object.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected RegionType contentType+
protected PageLayout pageLayout+
protected Layer layer+
protected int index+
protected org.primaresearch.dla.page.layout.physical.impl.RegionIterator.NestedRegionIterator currentNestedRegionIterator+
public RegionIterator(PageLayout pageLayout, + RegionType contentType, + Layer layer)+
contentType - Specific region type (e.g. table) or null to include all regionslayer - Restrict the iterator to this layer (use null for no restriction)public boolean hasNext()+
ContentIteratorhasNext in interface ContentIteratorpublic ContentObject next()+
ContentIteratornext in interface ContentIteratorpublic ContentType getContentType()+
ContentIteratorgetContentType in interface ContentIteratorpublic Layer getLayer()+
ContentIteratornull for no restriction)getLayer in interface ContentIteratorCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/SeparatorRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/SeparatorRegion.html new file mode 100644 index 00000000..35c6c28f --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/SeparatorRegion.html @@ -0,0 +1,341 @@ + + + + + +public class SeparatorRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
SeparatorRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getColour() |
+
double |
+getOrientation() |
+
void |
+setColour(java.lang.String colour) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic SeparatorRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/TableRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/TableRegion.html new file mode 100644 index 00000000..87dc9d40 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/TableRegion.html @@ -0,0 +1,471 @@ + + + + + +public class TableRegion +extends RegionImpl+
TEMP_ID_SUFFIX| Constructor and Description | +
|---|
TableRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+getBgColour() |
+
java.lang.String |
+getLineColour() |
+
int |
+getNumberOfColumns() |
+
int |
+getNumberOfRows() |
+
double |
+getOrientation() |
+
boolean |
+hasEmbeddedText() |
+
boolean |
+hasLineSeparators() |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setEmbeddedText(boolean hasText) |
+
void |
+setLineColour(java.lang.String colour) |
+
void |
+setLineSeparators(boolean hasLineSeparators) |
+
void |
+setNumberOfColumns(int cols) |
+
void |
+setNumberOfRows(int rows) |
+
void |
+setOrientation(double orientation) |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, getType, hasRegions, isTemporary, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic TableRegion(org.primaresearch.ident.IdRegister idRegister, + RegionType type, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public java.lang.String getLineColour()+
public void setLineColour(java.lang.String colour)+
public double getOrientation()+
public void setOrientation(double orientation)+
public boolean hasEmbeddedText()+
public void setEmbeddedText(boolean hasText)+
public boolean hasLineSeparators()+
public void setLineSeparators(boolean hasLineSeparators)+
public int getNumberOfRows()+
public void setNumberOfRows(int rows)+
public int getNumberOfColumns()+
public void setNumberOfColumns(int cols)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/AdvertRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/AdvertRegion.html new file mode 100644 index 00000000..93c53c4e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/AdvertRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ChartRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ChartRegion.html new file mode 100644 index 00000000..ec5c6eba --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ChartRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ChemRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ChemRegion.html new file mode 100644 index 00000000..023166ff --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ChemRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/FrameRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/FrameRegion.html new file mode 100644 index 00000000..13cc4f57 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/FrameRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/GraphicRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/GraphicRegion.html new file mode 100644 index 00000000..12aab9e7 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/GraphicRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ImageRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ImageRegion.html new file mode 100644 index 00000000..55ad4dd0 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/ImageRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/LineDrawingRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/LineDrawingRegion.html new file mode 100644 index 00000000..e2a7cee4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/LineDrawingRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/LowLevelTextObjectIterator.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/LowLevelTextObjectIterator.html new file mode 100644 index 00000000..999dbcde --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/LowLevelTextObjectIterator.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/MathsRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/MathsRegion.html new file mode 100644 index 00000000..71987d29 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/MathsRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/MusicRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/MusicRegion.html new file mode 100644 index 00000000..d3a80161 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/MusicRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/NoiseRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/NoiseRegion.html new file mode 100644 index 00000000..be8238fe --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/NoiseRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/RegionImpl.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/RegionImpl.html new file mode 100644 index 00000000..d96869f7 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/RegionImpl.html @@ -0,0 +1,248 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdvertRegion
+Specialised implementation for advert regions.
+ |
+
class |
+ChartRegion
+Specialised implementation for chart regions.
+ |
+
class |
+ChemRegion
+Specialised implementation for chemical formula regions.
+ |
+
class |
+FrameRegion
+Specialised implementation for frame regions.
+ |
+
class |
+GraphicRegion
+Specialised implementation for graphic regions.
+ |
+
class |
+ImageRegion
+Specialised implementation for image regions.
+ |
+
class |
+LineDrawingRegion
+Specialised implementation for line drawing regions.
+ |
+
class |
+MathsRegion
+Specialised implementation for maths regions.
+ |
+
class |
+MusicRegion
+Specialised implementation for musical notation regions.
+ |
+
class |
+NoiseRegion
+Specialised implementation for noise regions.
+ |
+
class |
+SeparatorRegion
+Specialised implementation for separator regions.
+ |
+
class |
+TableRegion
+Specialised implementation for table regions.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TextRegion
+Specialised layout region for text.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/RegionIterator.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/RegionIterator.html new file mode 100644 index 00000000..f7848672 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/RegionIterator.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/SeparatorRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/SeparatorRegion.html new file mode 100644 index 00000000..a665d731 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/SeparatorRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/TableRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/TableRegion.html new file mode 100644 index 00000000..0bc09ca7 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/class-use/TableRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-frame.html new file mode 100644 index 00000000..85170882 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-frame.html @@ -0,0 +1,33 @@ + + + + + +| Class | +Description | +
|---|---|
| AdvertRegion | +
+ Specialised implementation for advert regions.
+ |
+
| ChartRegion | +
+ Specialised implementation for chart regions.
+ |
+
| ChemRegion | +
+ Specialised implementation for chemical formula regions.
+ |
+
| FrameRegion | +
+ Specialised implementation for frame regions.
+ |
+
| GraphicRegion | +
+ Specialised implementation for graphic regions.
+ |
+
| ImageRegion | +
+ Specialised implementation for image regions.
+ |
+
| LineDrawingRegion | +
+ Specialised implementation for line drawing regions.
+ |
+
| LowLevelTextObjectIterator | +
+ Page content object iterator implementation for low level text objects (text lines, words, and glyphs).
+ |
+
| MathsRegion | +
+ Specialised implementation for maths regions.
+ |
+
| MusicRegion | +
+ Specialised implementation for musical notation regions.
+ |
+
| NoiseRegion | +
+ Specialised implementation for noise regions.
+ |
+
| RegionImpl | +
+ Basic implementation for layout regions.
+ |
+
| RegionIterator | +
+ Page content object iterator implementation for regions (zones/blocks).
+ |
+
| SeparatorRegion | +
+ Specialised implementation for separator regions.
+ |
+
| TableRegion | +
+ Specialised implementation for table regions.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-tree.html new file mode 100644 index 00000000..62518495 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-tree.html @@ -0,0 +1,146 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-use.html new file mode 100644 index 00000000..4368effb --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/impl/package-use.html @@ -0,0 +1,172 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Class and Description | +
|---|
| RegionImpl
+ Basic implementation for layout regions.
+ |
+
| Class and Description | +
|---|
| RegionImpl
+ Basic implementation for layout regions.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-frame.html new file mode 100644 index 00000000..23445084 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-frame.html @@ -0,0 +1,30 @@ + + + + + +| Interface | +Description | +
|---|---|
| AttributeContainer | +
+ Represents an object that can have Attributes.
+ |
+
| AttributeFactory | +
+ Interface for factories that create attribute collections for page content objects.
+ |
+
| ContentIterator | +
+ Iterator for all page content objects of a specified type
+ |
+
| ContentObject | +
+ Represents physical page content objects (e.g.
+ |
+
| Region | +
+ Layout region
+ |
+
| RegionContainer | +
+ Interface for classes that are able to contain nested layout regions.
+ |
+
| Class | +Description | +
|---|---|
| ContentFactory | +
+ Factory for creating page content objects.
+ |
+
| ContentObjectProcessor | +
+ Processes all content objects of a page using a customisable processing method.
+ |
+
| DefaultAttributeFactory | +
+ Attribute factory for the default layout content types of PAGE (static/dynamic).
++ + In static mode types and attributes are hard coded. |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-tree.html new file mode 100644 index 00000000..e89b3aa5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-tree.html @@ -0,0 +1,168 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-use.html new file mode 100644 index 00000000..f514318e --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/package-use.html @@ -0,0 +1,367 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Class and Description | +
|---|
| AttributeContainer
+ Represents an object that can have Attributes.
+ |
+
| Class and Description | +
|---|
| ContentFactory
+ Factory for creating page content objects.
+ |
+
| ContentIterator
+ Iterator for all page content objects of a specified type
+ |
+
| ContentObject
+ Represents physical page content objects (e.g.
+ |
+
| Region
+ Layout region
+ |
+
| RegionContainer
+ Interface for classes that are able to contain nested layout regions.
+ |
+
| Class and Description | +
|---|
| ContentFactory
+ Factory for creating page content objects.
+ |
+
| ContentObject
+ Represents physical page content objects (e.g.
+ |
+
| Class and Description | +
|---|
| AttributeContainer
+ Represents an object that can have Attributes.
+ |
+
| AttributeFactory
+ Interface for factories that create attribute collections for page content objects.
+ |
+
| ContentObject
+ Represents physical page content objects (e.g.
+ |
+
| Region
+ Layout region
+ |
+
| RegionContainer
+ Interface for classes that are able to contain nested layout regions.
+ |
+
| Class and Description | +
|---|
| AttributeContainer
+ Represents an object that can have Attributes.
+ |
+
| ContentIterator
+ Iterator for all page content objects of a specified type
+ |
+
| ContentObject
+ Represents physical page content objects (e.g.
+ |
+
| Region
+ Layout region
+ |
+
| RegionContainer
+ Interface for classes that are able to contain nested layout regions.
+ |
+
| Class and Description | +
|---|
| AttributeContainer
+ Represents an object that can have Attributes.
+ |
+
| ContentObject
+ Represents physical page content objects (e.g.
+ |
+
| Class and Description | +
|---|
| AttributeContainer
+ Represents an object that can have Attributes.
+ |
+
| ContentFactory
+ Factory for creating page content objects.
+ |
+
| ContentObject
+ Represents physical page content objects (e.g.
+ |
+
| Region
+ Layout region
+ |
+
| RegionContainer
+ Interface for classes that are able to contain nested layout regions.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/ContentType.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/ContentType.html new file mode 100644 index 00000000..64449bde --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/ContentType.html @@ -0,0 +1,364 @@ + + + + + +public class ContentType
+extends java.lang.Object
+implements java.io.Serializable
+| Modifier and Type | +Field and Description | +
|---|---|
static ContentType |
+Page
+Content type for a document page itself
+ |
+
| Modifier | +Constructor and Description | +
|---|---|
protected |
+ContentType()
+Empty constructor (required for GWT)
+ |
+
protected |
+ContentType(java.lang.String name)
+Constructor
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(ContentType other) |
+
java.lang.String |
+getName()
+Returns the name of this type
+ |
+
void |
+init(java.lang.String name)
+Initialises this type
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final ContentType Page+
protected ContentType()+
protected ContentType(java.lang.String name)+
name - Type namepublic java.lang.String getName()+
public void init(java.lang.String name)+
name - Type namepublic boolean equals(ContentType other)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/LowLevelTextType.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/LowLevelTextType.html new file mode 100644 index 00000000..57dd3f6a --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/LowLevelTextType.html @@ -0,0 +1,349 @@ + + + + + +public class LowLevelTextType +extends ContentType+
| Modifier and Type | +Field and Description | +
|---|---|
static LowLevelTextType |
+Glyph
+Type for glyph objects
+ |
+
static LowLevelTextType |
+TextLine
+Type for text line objects
+ |
+
static LowLevelTextType |
+Word
+Type for word objects
+ |
+
Page| Modifier | +Constructor and Description | +
|---|---|
protected |
+LowLevelTextType()
+Empty constructor (required for GWT)
+ |
+
protected |
+LowLevelTextType(java.lang.String name)
+Constructor
+ |
+
public static final LowLevelTextType TextLine+
public static final LowLevelTextType Word+
public static final LowLevelTextType Glyph+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/RegionType.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/RegionType.html new file mode 100644 index 00000000..a1777cb5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/RegionType.html @@ -0,0 +1,509 @@ + + + + + +public class RegionType +extends ContentType+
| Modifier and Type | +Field and Description | +
|---|---|
static RegionType |
+AdvertRegion
+For advertisements
+ |
+
static RegionType |
+ChartRegion
+For charts
+ |
+
static RegionType |
+ChemRegion
+For chemical notations
+ |
+
static RegionType |
+GraphicRegion
+For graphics
+ |
+
static RegionType |
+ImageRegion
+For image regions
+ |
+
static RegionType |
+LineDrawingRegion
+For line drawings
+ |
+
static RegionType |
+MathsRegion
+For mathematical formulas/equations
+ |
+
static RegionType |
+MusicRegion
+For musical notations
+ |
+
static RegionType |
+NoiseRegion
+For noise on the page
+ |
+
static RegionType |
+SeparatorRegion
+For separators
+ |
+
static RegionType |
+TableRegion
+For tables
+ |
+
static RegionType |
+TextRegion
+For text regions
+ |
+
static RegionType |
+UnknownRegion
+For regions of unknown/undetermined type
+ |
+
Page| Modifier | +Constructor and Description | +
|---|---|
protected |
+RegionType()
+Empty constructor (required for GWT)
+ |
+
protected |
+RegionType(java.lang.String name)
+Constructor
+ |
+
public static final RegionType TextRegion+
public static final RegionType ImageRegion+
public static final RegionType GraphicRegion+
public static final RegionType LineDrawingRegion+
public static final RegionType ChartRegion+
public static final RegionType TableRegion+
public static final RegionType MathsRegion+
public static final RegionType SeparatorRegion+
public static final RegionType AdvertRegion+
public static final RegionType ChemRegion+
public static final RegionType MusicRegion+
public static final RegionType NoiseRegion+
public static final RegionType UnknownRegion+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/ContentType.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/ContentType.html new file mode 100644 index 00000000..cc662828 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/ContentType.html @@ -0,0 +1,390 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.shared | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+XmlNameProvider.getXmlName(ContentType type) |
+
java.lang.String |
+DefaultXmlNames.getXmlName(ContentType type) |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+PageLayout.getObject(ContentType type,
+ java.lang.String id)
+Returns the content object of given type and ID
+ |
+
ContentObject |
+PageLayout.getObjectAt(int x,
+ int y,
+ ContentType type)
+Looks for a content object of a specific type at the given position within the document page.
+ |
+
ContentObjectRelation |
+PageLayout.getParentChildRelation(ContentType childType,
+ java.lang.String childId)
+Returns a parent-child relation object
+ |
+
ContentIterator |
+PageLayout.iterator(ContentType contentType)
+Returns a new iterator for a specific page content type.
+ |
+
ContentIterator |
+PageLayout.iterator(ContentType contentType,
+ Layer layer)
+Returns a new iterator for a specific page content type.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentType |
+ContentIterator.getContentType()
+Returns the content type of the page content objects this iterator was created for.
+ |
+
ContentType |
+ContentObject.getType()
+Returns the type of this page content object
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
org.primaresearch.shared.variable.VariableMap |
+DefaultAttributeFactory.createAttributes(ContentType type) |
+
org.primaresearch.shared.variable.VariableMap |
+AttributeFactory.createAttributes(ContentType type)
+Returns a collection of attributes suitable for content objects of the given type.
+ |
+
ContentObject |
+ContentFactory.createContent(ContentType type)
+Creates a new content object of the given type
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentType |
+RegionIterator.getContentType() |
+
ContentType |
+LowLevelTextObjectIterator.getContentType() |
+
ContentType |
+RegionImpl.getType() |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LowLevelTextType
+Content types for low level text objects (text lines, words, glyphs).
+ |
+
class |
+RegionType
+Content types for layout regions.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static ContentType |
+ContentType.Page
+Content type for a document page itself
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+ContentType.equals(ContentType other) |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentType |
+Word.getType() |
+
ContentType |
+TextRegion.getType() |
+
ContentType |
+TextLine.getType() |
+
ContentType |
+Glyph.getType() |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/LowLevelTextType.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/LowLevelTextType.html new file mode 100644 index 00000000..c431b4eb --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/LowLevelTextType.html @@ -0,0 +1,218 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.shared | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+PageLayout.hasLowLevelTextObject(LowLevelTextType type)
+Checks if this page layout contains text objects of the given type
+ |
+
| Constructor and Description | +
|---|
LowLevelTextObjectIterator(PageLayout pageLayout,
+ LowLevelTextType contentType,
+ Layer layer)
+Constructor
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static LowLevelTextType |
+LowLevelTextType.Glyph
+Type for glyph objects
+ |
+
static LowLevelTextType |
+LowLevelTextType.TextLine
+Type for text line objects
+ |
+
static LowLevelTextType |
+LowLevelTextType.Word
+Type for word objects
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/RegionType.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/RegionType.html new file mode 100644 index 00000000..5f7a2eb2 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/class-use/RegionType.html @@ -0,0 +1,419 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.shared | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ContentObject |
+PageLayout.changeTypeOfRegion(ContentObject region,
+ RegionType newType)
+Creates a region object with the id of the given object and the new region type.
+ |
+
Region |
+PageLayout.createRegion(RegionType type)
+Creates a region of the specified type.
+ |
+
Region |
+PageLayout.createRegion(RegionType type,
+ java.lang.String id)
+Creates a region of the specified type.
+ |
+
Region |
+PageLayout.createRegion(RegionType type,
+ java.lang.String id,
+ RegionContainer parentRegion)
+Creates a region of the specified type.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected RegionType |
+RegionIterator.contentType |
+
| Constructor and Description | +
|---|
AdvertRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
ChartRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
ChemRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
FrameRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
GraphicRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
ImageRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
LineDrawingRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
MathsRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
MusicRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
NoiseRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
RegionImpl(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion)
+Constructor
+ |
+
RegionIterator(PageLayout pageLayout,
+ RegionType contentType,
+ Layer layer)
+Constructor
+ |
+
SeparatorRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
TableRegion(org.primaresearch.ident.IdRegister idRegister,
+ RegionType type,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Field and Description | +
|---|---|
static RegionType |
+RegionType.AdvertRegion
+For advertisements
+ |
+
static RegionType |
+RegionType.ChartRegion
+For charts
+ |
+
static RegionType |
+RegionType.ChemRegion
+For chemical notations
+ |
+
static RegionType |
+RegionType.GraphicRegion
+For graphics
+ |
+
static RegionType |
+RegionType.ImageRegion
+For image regions
+ |
+
static RegionType |
+RegionType.LineDrawingRegion
+For line drawings
+ |
+
static RegionType |
+RegionType.MathsRegion
+For mathematical formulas/equations
+ |
+
static RegionType |
+RegionType.MusicRegion
+For musical notations
+ |
+
static RegionType |
+RegionType.NoiseRegion
+For noise on the page
+ |
+
static RegionType |
+RegionType.SeparatorRegion
+For separators
+ |
+
static RegionType |
+RegionType.TableRegion
+For tables
+ |
+
static RegionType |
+RegionType.TextRegion
+For text regions
+ |
+
static RegionType |
+RegionType.UnknownRegion
+For regions of unknown/undetermined type
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-frame.html new file mode 100644 index 00000000..03343356 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-frame.html @@ -0,0 +1,21 @@ + + + + + +| Class | +Description | +
|---|---|
| ContentType | +
+ Base class for different types of page content.
+ |
+
| LowLevelTextType | +
+ Content types for low level text objects (text lines, words, glyphs).
+ |
+
| RegionType | +
+ Content types for layout regions.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-tree.html new file mode 100644 index 00000000..62f7184f --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-tree.html @@ -0,0 +1,134 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-use.html new file mode 100644 index 00000000..94b5f100 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/shared/package-use.html @@ -0,0 +1,286 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.io.xml | ++ |
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.shared | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Class and Description | +
|---|
| ContentType
+ Base class for different types of page content.
+ |
+
| Class and Description | +
|---|
| ContentType
+ Base class for different types of page content.
+ |
+
| LowLevelTextType
+ Content types for low level text objects (text lines, words, glyphs).
+ |
+
| RegionType
+ Content types for layout regions.
+ |
+
| Class and Description | +
|---|
| ContentType
+ Base class for different types of page content.
+ |
+
| Class and Description | +
|---|
| ContentType
+ Base class for different types of page content.
+ |
+
| LowLevelTextType
+ Content types for low level text objects (text lines, words, glyphs).
+ |
+
| RegionType
+ Content types for layout regions.
+ |
+
| Class and Description | +
|---|
| ContentType
+ Base class for different types of page content.
+ |
+
| LowLevelTextType
+ Content types for low level text objects (text lines, words, glyphs).
+ |
+
| RegionType
+ Content types for layout regions.
+ |
+
| Class and Description | +
|---|
| ContentType
+ Base class for different types of page content.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainer.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainer.html new file mode 100644 index 00000000..ee49d805 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainer.html @@ -0,0 +1,363 @@ + + + + + +public interface LowLevelTextContainer
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+addTextObject(LowLevelTextObject textObj)
+Adds a child text object
+ |
+
java.lang.String |
+composeText(boolean replaceTextContent,
+ boolean recursive)
+Composes the text for this object using the child text objects.
+ |
+
LowLevelTextObject |
+getTextObject(org.primaresearch.ident.Id id)
+Returns a child text object
+ |
+
LowLevelTextObject |
+getTextObject(int index)
+Returns a child text object
+ |
+
int |
+getTextObjectCount()
+Returns the number of child text objects
+ |
+
java.util.List<LowLevelTextObject> |
+getTextObjectsSorted()
+Returns a sorted list of all text objects (sorts by x or y position, depending on the object type).
+ |
+
boolean |
+hasTextObjects()
+Checks if there child text objects
+ |
+
void |
+removeTextObject(org.primaresearch.ident.Id id)
+Removes a child text object
+ |
+
void |
+removeTextObject(int index)
+Removes a child text object
+ |
+
boolean hasTextObjects()+
true if there are children, false if emptyint getTextObjectCount()+
LowLevelTextObject getTextObject(int index) + throws java.lang.IndexOutOfBoundsException+
index - Positionjava.lang.IndexOutOfBoundsException - Invalid indexLowLevelTextObject getTextObject(org.primaresearch.ident.Id id)+
id - ID of childvoid addTextObject(LowLevelTextObject textObj)+
textObj - Object to addvoid removeTextObject(int index) + throws java.lang.IndexOutOfBoundsException+
index - Positionjava.lang.IndexOutOfBoundsException - Invalid indexvoid removeTextObject(org.primaresearch.ident.Id id)+
id - ID of childjava.util.List<LowLevelTextObject> getTextObjectsSorted()+
java.lang.String composeText(boolean replaceTextContent, + boolean recursive)+
replaceTextContent - If set to true the text content of this object will be replaced by the composed text (only if the composed text is not empty)recursive - If set to true all lower levels of text objects are used for the compositionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainerImpl.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainerImpl.html new file mode 100644 index 00000000..6f5882dc --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainerImpl.html @@ -0,0 +1,354 @@ + + + + + +public class LowLevelTextContainerImpl
+extends java.lang.Object
+| Constructor and Description | +
|---|
LowLevelTextContainerImpl() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addTextObject(LowLevelTextObject textObj) |
+
LowLevelTextObject |
+getTextObject(org.primaresearch.ident.Id id) |
+
LowLevelTextObject |
+getTextObject(int index) |
+
int |
+getTextObjectCount() |
+
java.util.List<LowLevelTextObject> |
+getTextObjectsSorted(boolean sortByX) |
+
boolean |
+hasTextObjects() |
+
void |
+removeTextObject(org.primaresearch.ident.Id id) |
+
void |
+removeTextObject(int index) |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic LowLevelTextContainerImpl()+
public boolean hasTextObjects()+
public int getTextObjectCount()+
public LowLevelTextObject getTextObject(int index)+
public void addTextObject(LowLevelTextObject textObj)+
public LowLevelTextObject getTextObject(org.primaresearch.ident.Id id)+
public void removeTextObject(int index) + throws java.lang.IndexOutOfBoundsException+
java.lang.IndexOutOfBoundsExceptionpublic void removeTextObject(org.primaresearch.ident.Id id)+
public java.util.List<LowLevelTextObject> getTextObjectsSorted(boolean sortByX)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextObject.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextObject.html new file mode 100644 index 00000000..0bfe3686 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/LowLevelTextObject.html @@ -0,0 +1,603 @@ + + + + + +public abstract class LowLevelTextObject +extends java.lang.Object +implements TextObject, ContentObject+
TEMP_ID_SUFFIX| Modifier | +Constructor and Description | +
|---|---|
protected |
+LowLevelTextObject(org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parent) |
+
| Modifier and Type | +Method and Description | +
|---|---|
org.primaresearch.shared.variable.VariableMap |
+getAttributes()
+Returns the attributes of the object.
+ |
+
java.lang.Double |
+getConfidence()
+Returns the OCR confidence for the text content.
+ |
+
org.primaresearch.maths.geometry.Polygon |
+getCoords()
+Returns the location of the object.
+ |
+
org.primaresearch.ident.Id |
+getId() |
+
org.primaresearch.ident.IdRegister |
+getIdRegister() |
+
LowLevelTextContainer |
+getParent() |
+
java.lang.String |
+getPlainText()
+Returns the plain text.
+ |
+
java.lang.String |
+getText()
+Returns the Unicode text.
+ |
+
boolean |
+isTemporary()
+Checks if this is a temporary content object
+ |
+
void |
+setConfidence(java.lang.Double confidence)
+Sets the OCR confidence for the text content.
+ |
+
void |
+setCoords(org.primaresearch.maths.geometry.Polygon coords)
+Sets the location of the object
+ |
+
void |
+setId(org.primaresearch.ident.Id id) |
+
void |
+setId(java.lang.String id) |
+
void |
+setParent(LowLevelTextContainer parent) |
+
void |
+setPlainText(java.lang.String text)
+Sets the plain text.
+ |
+
void |
+setText(java.lang.String text)
+Sets the Unicode text.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitisBold, isItalic, isLetterSpaced, isSmallCaps, isStrikethrough, isSubscript, isSuperscript, isUnderlined, setBold, setItalic, setLetterSpaced, setSmallCaps, setStrikethrough, setSubscript, setSuperscript, setUnderlinedgetTypeprotected LowLevelTextObject(org.primaresearch.ident.IdRegister idRegister, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + LowLevelTextContainer parent)+
public java.lang.String getText()+
TextObjectgetText in interface TextObjectpublic java.lang.String getPlainText()+
TextObjectgetPlainText in interface TextObjectpublic void setText(java.lang.String text)+
TextObjectsetText in interface TextObjectpublic void setPlainText(java.lang.String text)+
TextObjectsetPlainText in interface TextObjectpublic org.primaresearch.shared.variable.VariableMap getAttributes()+
AttributeContainergetAttributes in interface AttributeContainerpublic org.primaresearch.maths.geometry.Polygon getCoords()+
GeometricObjectgetCoords in interface GeometricObjectpublic void setCoords(org.primaresearch.maths.geometry.Polygon coords)+
GeometricObjectsetCoords in interface GeometricObjectcoords - A polygonpublic org.primaresearch.ident.Id getId()+
getId in interface org.primaresearch.ident.Identifiablepublic org.primaresearch.ident.IdRegister getIdRegister()+
getIdRegister in interface org.primaresearch.ident.Identifiablepublic void setId(java.lang.String id) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
setId in interface org.primaresearch.ident.Identifiableorg.primaresearch.ident.IdRegister.InvalidIdExceptionpublic void setId(org.primaresearch.ident.Id id) + throws org.primaresearch.ident.IdRegister.InvalidIdException+
setId in interface org.primaresearch.ident.Identifiableorg.primaresearch.ident.IdRegister.InvalidIdExceptionpublic boolean isTemporary()+
ContentObjectisTemporary in interface ContentObjecttrue if temporary, false if normal content objectpublic java.lang.Double getConfidence()+
TextObjectgetConfidence in interface TextObjectpublic void setConfidence(java.lang.Double confidence)+
TextObjectsetConfidence in interface TextObjectpublic LowLevelTextContainer getParent()+
public void setParent(LowLevelTextContainer parent)+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/TextObject.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/TextObject.html new file mode 100644 index 00000000..17db908f --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/TextObject.html @@ -0,0 +1,569 @@ + + + + + +public interface TextObject
+| Modifier and Type | +Method and Description | +
|---|---|
java.lang.Double |
+getConfidence()
+Returns the OCR confidence for the text content.
+ |
+
java.lang.String |
+getPlainText()
+Returns the plain text.
+ |
+
java.lang.String |
+getText()
+Returns the Unicode text.
+ |
+
java.lang.Boolean |
+isBold()
+Bold text?
+ |
+
java.lang.Boolean |
+isItalic()
+Italic text?
+ |
+
java.lang.Boolean |
+isLetterSpaced()
+Letter spaced (gaps between characters)?
+ |
+
java.lang.Boolean |
+isSmallCaps()
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
java.lang.Boolean |
+isStrikethrough()
+Strikethrough (line through text)?
+ |
+
java.lang.Boolean |
+isSubscript()
+Subscript (small letters below the baseline)?
+ |
+
java.lang.Boolean |
+isSuperscript()
+Superscript (small letters above the line of text)?
+ |
+
java.lang.Boolean |
+isUnderlined()
+Underlined text?
+ |
+
void |
+setBold(java.lang.Boolean bold)
+Bold text?
+ |
+
void |
+setConfidence(java.lang.Double confidence)
+Sets the OCR confidence for the text content.
+ |
+
void |
+setItalic(java.lang.Boolean italic)
+Italic text?
+ |
+
void |
+setLetterSpaced(java.lang.Boolean letterSpaced)
+Letter spaced (gaps between characters)?
+ |
+
void |
+setPlainText(java.lang.String text)
+Sets the plain text.
+ |
+
void |
+setSmallCaps(java.lang.Boolean smallCaps)
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
void |
+setStrikethrough(java.lang.Boolean strikethrough)
+Strikethrough (line through text)?
+ |
+
void |
+setSubscript(java.lang.Boolean subscript)
+Subscript (small letters below the baseline)?
+ |
+
void |
+setSuperscript(java.lang.Boolean superscript)
+Superscript (small letters above the line of text)?
+ |
+
void |
+setText(java.lang.String text)
+Sets the Unicode text.
+ |
+
void |
+setUnderlined(java.lang.Boolean underlined)
+Underlined text?
+ |
+
java.lang.String getText()+
java.lang.String getPlainText()+
void setText(java.lang.String text)+
void setPlainText(java.lang.String text)+
java.lang.Double getConfidence()+
void setConfidence(java.lang.Double confidence)+
java.lang.Boolean isBold()+
true for bold text, false for normal text, or null if not set.void setBold(java.lang.Boolean bold)+
bold - true for bold text, false for normal text, or null for 'not set'.java.lang.Boolean isItalic()+
true for italic text, false for normal text, or null if not set.void setItalic(java.lang.Boolean italic)+
italic - true for italic text, false for normal text, or null for 'not set'.java.lang.Boolean isUnderlined()+
true for underlined text, false for not underlined text, or null if not set.void setUnderlined(java.lang.Boolean underlined)+
underlined - true for underlined text, false for not underlined text, or null if not set.java.lang.Boolean isSubscript()+
true for subscript, false for normal text, or null if not set.void setSubscript(java.lang.Boolean subscript)+
subscript - true for subscript, false for normal text, or null if not set.java.lang.Boolean isSuperscript()+
true for superscript, false for normal text, or null if not set.void setSuperscript(java.lang.Boolean superscript)+
superscript - true for superscript, false for normal text, or null if not set.java.lang.Boolean isStrikethrough()+
true for strikethrough, false for normal text, or null if not set.void setStrikethrough(java.lang.Boolean strikethrough)+
strikethrough - true for strikethrough, false for normal text, or null if not set.java.lang.Boolean isSmallCaps()+
true for small caps, false for normal text, or null if not set.void setSmallCaps(java.lang.Boolean smallCaps)+
smallCaps - true for small caps, false for normal text, or null if not set.java.lang.Boolean isLetterSpaced()+
true for letter spaced text, false for normal text, or null if not set.void setLetterSpaced(java.lang.Boolean letterSpaced)+
letterSpaced - true for letter spaced text, false for normal text, or null if not set.Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextContainer.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextContainer.html new file mode 100644 index 00000000..9916439b --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextContainer.html @@ -0,0 +1,251 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
LowLevelTextContainer |
+LowLevelTextObject.getParent() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LowLevelTextObject.setParent(LowLevelTextContainer parent) |
+
| Constructor and Description | +
|---|
LowLevelTextObject(org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parent) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TextLine
+Specialised low level text object representing text lines within a page layout.
+ |
+
class |
+TextRegion
+Specialised layout region for text.
+ |
+
class |
+Word
+Specialised low level text object representing words within a page layout.
+ |
+
| Constructor and Description | +
|---|
Glyph(org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parentWord) |
+
TextLine(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parentRegion) |
+
Word(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parentLine) |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextContainerImpl.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextContainerImpl.html new file mode 100644 index 00000000..cddafeaa --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextContainerImpl.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextObject.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextObject.html new file mode 100644 index 00000000..8a3b2437 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/LowLevelTextObject.html @@ -0,0 +1,321 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
LowLevelTextObject |
+LowLevelTextContainerImpl.getTextObject(org.primaresearch.ident.Id id) |
+
LowLevelTextObject |
+LowLevelTextContainer.getTextObject(org.primaresearch.ident.Id id)
+Returns a child text object
+ |
+
LowLevelTextObject |
+LowLevelTextContainerImpl.getTextObject(int index) |
+
LowLevelTextObject |
+LowLevelTextContainer.getTextObject(int index)
+Returns a child text object
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<LowLevelTextObject> |
+LowLevelTextContainer.getTextObjectsSorted()
+Returns a sorted list of all text objects (sorts by x or y position, depending on the object type).
+ |
+
java.util.List<LowLevelTextObject> |
+LowLevelTextContainerImpl.getTextObjectsSorted(boolean sortByX) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+LowLevelTextContainerImpl.addTextObject(LowLevelTextObject textObj) |
+
void |
+LowLevelTextContainer.addTextObject(LowLevelTextObject textObj)
+Adds a child text object
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Glyph
+Specialised low level text object representing glyphs within a page layout.
+ |
+
class |
+TextLine
+Specialised low level text object representing text lines within a page layout.
+ |
+
class |
+Word
+Specialised low level text object representing words within a page layout.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
LowLevelTextObject |
+Word.getTextObject(org.primaresearch.ident.Id id) |
+
LowLevelTextObject |
+TextRegion.getTextObject(org.primaresearch.ident.Id id) |
+
LowLevelTextObject |
+TextLine.getTextObject(org.primaresearch.ident.Id id) |
+
LowLevelTextObject |
+Word.getTextObject(int index) |
+
LowLevelTextObject |
+TextRegion.getTextObject(int index) |
+
LowLevelTextObject |
+TextLine.getTextObject(int index) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<LowLevelTextObject> |
+Word.getTextObjectsSorted() |
+
java.util.List<LowLevelTextObject> |
+TextRegion.getTextObjectsSorted() |
+
java.util.List<LowLevelTextObject> |
+TextLine.getTextObjectsSorted() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Word.addTextObject(LowLevelTextObject textObj) |
+
void |
+TextRegion.addTextObject(LowLevelTextObject textObj) |
+
void |
+TextLine.addTextObject(LowLevelTextObject textObj) |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/TextObject.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/TextObject.html new file mode 100644 index 00000000..a5eaaa2f --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/class-use/TextObject.html @@ -0,0 +1,200 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LowLevelTextObject
+Abstract class representing low level text objects such as text line, word and glyph.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Glyph
+Specialised low level text object representing glyphs within a page layout.
+ |
+
class |
+TextLine
+Specialised low level text object representing text lines within a page layout.
+ |
+
class |
+TextRegion
+Specialised layout region for text.
+ |
+
class |
+Word
+Specialised low level text object representing words within a page layout.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/DefaultTextRegionTypes.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/DefaultTextRegionTypes.html new file mode 100644 index 00000000..21184982 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/DefaultTextRegionTypes.html @@ -0,0 +1,435 @@ + + + + + +public interface DefaultTextRegionTypes
+| Modifier and Type | +Field and Description | +
|---|---|
static java.lang.String |
+CAPTION |
+
static java.lang.String |
+CATCH_WORD |
+
static java.lang.String |
+CREDIT |
+
static java.lang.String |
+DROP_CAPITAL |
+
static java.lang.String |
+ENDNOTE |
+
static java.lang.String |
+FLOATING |
+
static java.lang.String |
+FOOTER |
+
static java.lang.String |
+FOOTNOTE |
+
static java.lang.String |
+FOOTNOTE_CONTINUED |
+
static java.lang.String |
+HEADER |
+
static java.lang.String |
+HEADING |
+
static java.lang.String |
+MARGINALIA |
+
static java.lang.String |
+OTHER |
+
static java.lang.String |
+PAGE_NUMBER |
+
static java.lang.String |
+PARAGRAPH |
+
static java.lang.String |
+SIGNATURE_MARK |
+
static java.lang.String |
+TOC_ENTRY |
+
static final java.lang.String PARAGRAPH+
static final java.lang.String HEADING+
static final java.lang.String CAPTION+
static final java.lang.String HEADER+
static final java.lang.String FOOTER+
static final java.lang.String PAGE_NUMBER+
static final java.lang.String DROP_CAPITAL+
static final java.lang.String CREDIT+
static final java.lang.String FLOATING+
static final java.lang.String SIGNATURE_MARK+
static final java.lang.String CATCH_WORD+
static final java.lang.String MARGINALIA+
static final java.lang.String FOOTNOTE+
static final java.lang.String FOOTNOTE_CONTINUED+
static final java.lang.String TOC_ENTRY+
static final java.lang.String ENDNOTE+
static final java.lang.String OTHER+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/Glyph.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/Glyph.html new file mode 100644 index 00000000..a5990ec8 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/Glyph.html @@ -0,0 +1,593 @@ + + + + + +public class Glyph +extends LowLevelTextObject+
TEMP_ID_SUFFIX| Modifier | +Constructor and Description | +
|---|---|
protected |
+Glyph(org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parentWord) |
+
| Modifier and Type | +Method and Description | +
|---|---|
ContentType |
+getType()
+Returns the type of this page content object
+ |
+
java.lang.Boolean |
+isBold()
+Bold text?
+ |
+
java.lang.Boolean |
+isItalic()
+Italic text?
+ |
+
java.lang.Boolean |
+isLetterSpaced()
+Letter spaced (gaps between characters)?
+ |
+
java.lang.Boolean |
+isSmallCaps()
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
java.lang.Boolean |
+isStrikethrough()
+Strikethrough (line through text)?
+ |
+
java.lang.Boolean |
+isSubscript()
+Subscript (small letters below the baseline)?
+ |
+
java.lang.Boolean |
+isSuperscript()
+Superscript (small letters above the line of text)?
+ |
+
java.lang.Boolean |
+isUnderlined()
+Underlined text?
+ |
+
void |
+setBold(java.lang.Boolean bold)
+Bold text?
+ |
+
void |
+setItalic(java.lang.Boolean italic)
+Italic text?
+ |
+
void |
+setLetterSpaced(java.lang.Boolean letterSpaced)
+Letter spaced (gaps between characters)?
+ |
+
void |
+setSmallCaps(java.lang.Boolean smallCaps)
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
void |
+setStrikethrough(java.lang.Boolean strikethrough)
+Strikethrough (line through text)?
+ |
+
void |
+setSubscript(java.lang.Boolean subscript)
+Subscript (small letters below the baseline)?
+ |
+
void |
+setSuperscript(java.lang.Boolean superscript)
+Superscript (small letters above the line of text)?
+ |
+
void |
+setUnderlined(java.lang.Boolean underlined)
+Underlined text?
+ |
+
getAttributes, getConfidence, getCoords, getId, getIdRegister, getParent, getPlainText, getText, isTemporary, setConfidence, setCoords, setId, setId, setParent, setPlainText, setTextclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected Glyph(org.primaresearch.ident.IdRegister idRegister, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + LowLevelTextContainer parentWord)+
public ContentType getType()+
ContentObjectpublic java.lang.Boolean isBold()+
TextObjecttrue for bold text, false for normal text, or null if not set.public void setBold(java.lang.Boolean bold)+
TextObjectbold - true for bold text, false for normal text, or null for 'not set'.public java.lang.Boolean isItalic()+
TextObjecttrue for italic text, false for normal text, or null if not set.public void setItalic(java.lang.Boolean italic)+
TextObjectitalic - true for italic text, false for normal text, or null for 'not set'.public java.lang.Boolean isUnderlined()+
TextObjecttrue for underlined text, false for not underlined text, or null if not set.public void setUnderlined(java.lang.Boolean underlined)+
TextObjectunderlined - true for underlined text, false for not underlined text, or null if not set.public java.lang.Boolean isSubscript()+
TextObjecttrue for subscript, false for normal text, or null if not set.public void setSubscript(java.lang.Boolean subscript)+
TextObjectsubscript - true for subscript, false for normal text, or null if not set.public java.lang.Boolean isSuperscript()+
TextObjecttrue for superscript, false for normal text, or null if not set.public void setSuperscript(java.lang.Boolean superscript)+
TextObjectsuperscript - true for superscript, false for normal text, or null if not set.public java.lang.Boolean isStrikethrough()+
TextObjecttrue for strikethrough, false for normal text, or null if not set.public void setStrikethrough(java.lang.Boolean strikethrough)+
TextObjectstrikethrough - true for strikethrough, false for normal text, or null if not set.public java.lang.Boolean isSmallCaps()+
TextObjecttrue for small caps, false for normal text, or null if not set.public void setSmallCaps(java.lang.Boolean smallCaps)+
TextObjectsmallCaps - true for small caps, false for normal text, or null if not set.public java.lang.Boolean isLetterSpaced()+
TextObjecttrue for letter spaced text, false for normal text, or null if not set.public void setLetterSpaced(java.lang.Boolean letterSpaced)+
TextObjectletterSpaced - true for letter spaced text, false for normal text, or null if not set.Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/TextLine.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/TextLine.html new file mode 100644 index 00000000..1bdb0075 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/TextLine.html @@ -0,0 +1,934 @@ + + + + + +public class TextLine +extends LowLevelTextObject +implements LowLevelTextContainer+
TEMP_ID_SUFFIX| Modifier | +Constructor and Description | +
|---|---|
protected |
+TextLine(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addTextObject(LowLevelTextObject textObj)
+Adds a child text object
+ |
+
java.lang.String |
+composeText(boolean replaceTextContent,
+ boolean recursive)
+Composes the text for this object using the child text objects.
+ |
+
Word |
+createWord() |
+
Word |
+createWord(java.lang.String id)
+Creates a new word object and adds it to this text line.
+ |
+
org.primaresearch.maths.geometry.Polygon |
+getBaseline()
+Returns the baseline attached to this text line.
+ |
+
java.lang.String |
+getPrimaryLanguage() |
+
LowLevelTextObject |
+getTextObject(org.primaresearch.ident.Id id)
+Returns a child text object
+ |
+
LowLevelTextObject |
+getTextObject(int index)
+Returns a child text object
+ |
+
int |
+getTextObjectCount()
+Returns the number of child text objects
+ |
+
java.util.List<LowLevelTextObject> |
+getTextObjectsSorted()
+Returns a sorted list of all text objects (sorts by x or y position, depending on the object type).
+ |
+
ContentType |
+getType()
+Returns the type of this page content object
+ |
+
boolean |
+hasTextObjects()
+Checks if there child text objects
+ |
+
java.lang.Boolean |
+isBold()
+Bold text?
+ |
+
java.lang.Boolean |
+isItalic()
+Italic text?
+ |
+
java.lang.Boolean |
+isLetterSpaced()
+Letter spaced (gaps between characters)?
+ |
+
java.lang.Boolean |
+isSmallCaps()
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
java.lang.Boolean |
+isStrikethrough()
+Strikethrough (line through text)?
+ |
+
java.lang.Boolean |
+isSubscript()
+Subscript (small letters below the baseline)?
+ |
+
java.lang.Boolean |
+isSuperscript()
+Superscript (small letters above the line of text)?
+ |
+
java.lang.Boolean |
+isUnderlined()
+Underlined text?
+ |
+
void |
+removeTextObject(org.primaresearch.ident.Id id)
+Removes a child text object
+ |
+
void |
+removeTextObject(int index)
+Removes a child text object
+ |
+
void |
+setBaseline(org.primaresearch.maths.geometry.Polygon baseline)
+Sets the baseline attached to this text line.
+ |
+
void |
+setBold(java.lang.Boolean bold)
+Bold text?
+ |
+
void |
+setItalic(java.lang.Boolean italic)
+Italic text?
+ |
+
void |
+setLetterSpaced(java.lang.Boolean letterSpaced)
+Letter spaced (gaps between characters)?
+ |
+
void |
+setPrimaryLanguage(java.lang.String lang) |
+
void |
+setSmallCaps(java.lang.Boolean smallCaps)
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
void |
+setStrikethrough(java.lang.Boolean strikethrough)
+Strikethrough (line through text)?
+ |
+
void |
+setSubscript(java.lang.Boolean subscript)
+Subscript (small letters below the baseline)?
+ |
+
void |
+setSuperscript(java.lang.Boolean superscript)
+Superscript (small letters above the line of text)?
+ |
+
void |
+setUnderlined(java.lang.Boolean underlined)
+Underlined text?
+ |
+
getAttributes, getConfidence, getCoords, getId, getIdRegister, getParent, getPlainText, getText, isTemporary, setConfidence, setCoords, setId, setId, setParent, setPlainText, setTextclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected TextLine(ContentFactory contentFactory, + org.primaresearch.ident.IdRegister idRegister, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + LowLevelTextContainer parentRegion)+
public boolean hasTextObjects()+
LowLevelTextContainerhasTextObjects in interface LowLevelTextContainertrue if there are children, false if emptypublic int getTextObjectCount()+
LowLevelTextContainergetTextObjectCount in interface LowLevelTextContainerpublic LowLevelTextObject getTextObject(int index)+
LowLevelTextContainergetTextObject in interface LowLevelTextContainerindex - Positionpublic Word createWord()+
public Word createWord(java.lang.String id)+
id - Preferred ID for the word (not guaranteed, check the result word for the actual ID)public void addTextObject(LowLevelTextObject textObj)+
LowLevelTextContaineraddTextObject in interface LowLevelTextContainertextObj - Object to addpublic ContentType getType()+
ContentObjectgetType in interface ContentObjectpublic LowLevelTextObject getTextObject(org.primaresearch.ident.Id id)+
LowLevelTextContainergetTextObject in interface LowLevelTextContainerid - ID of childpublic void removeTextObject(int index) + throws java.lang.IndexOutOfBoundsException+
LowLevelTextContainerremoveTextObject in interface LowLevelTextContainerindex - Positionjava.lang.IndexOutOfBoundsException - Invalid indexpublic void removeTextObject(org.primaresearch.ident.Id id)+
LowLevelTextContainerremoveTextObject in interface LowLevelTextContainerid - ID of childpublic java.util.List<LowLevelTextObject> getTextObjectsSorted()+
LowLevelTextContainergetTextObjectsSorted in interface LowLevelTextContainerpublic org.primaresearch.maths.geometry.Polygon getBaseline()+
public void setBaseline(org.primaresearch.maths.geometry.Polygon baseline)+
public java.lang.Boolean isBold()+
TextObjectisBold in interface TextObjecttrue for bold text, false for normal text, or null if not set.public void setBold(java.lang.Boolean bold)+
TextObjectsetBold in interface TextObjectbold - true for bold text, false for normal text, or null for 'not set'.public java.lang.Boolean isItalic()+
TextObjectisItalic in interface TextObjecttrue for italic text, false for normal text, or null if not set.public void setItalic(java.lang.Boolean italic)+
TextObjectsetItalic in interface TextObjectitalic - true for italic text, false for normal text, or null for 'not set'.public java.lang.Boolean isUnderlined()+
TextObjectisUnderlined in interface TextObjecttrue for underlined text, false for not underlined text, or null if not set.public void setUnderlined(java.lang.Boolean underlined)+
TextObjectsetUnderlined in interface TextObjectunderlined - true for underlined text, false for not underlined text, or null if not set.public java.lang.Boolean isSubscript()+
TextObjectisSubscript in interface TextObjecttrue for subscript, false for normal text, or null if not set.public void setSubscript(java.lang.Boolean subscript)+
TextObjectsetSubscript in interface TextObjectsubscript - true for subscript, false for normal text, or null if not set.public java.lang.Boolean isSuperscript()+
TextObjectisSuperscript in interface TextObjecttrue for superscript, false for normal text, or null if not set.public void setSuperscript(java.lang.Boolean superscript)+
TextObjectsetSuperscript in interface TextObjectsuperscript - true for superscript, false for normal text, or null if not set.public java.lang.Boolean isStrikethrough()+
TextObjectisStrikethrough in interface TextObjecttrue for strikethrough, false for normal text, or null if not set.public void setStrikethrough(java.lang.Boolean strikethrough)+
TextObjectsetStrikethrough in interface TextObjectstrikethrough - true for strikethrough, false for normal text, or null if not set.public java.lang.Boolean isSmallCaps()+
TextObjectisSmallCaps in interface TextObjecttrue for small caps, false for normal text, or null if not set.public void setSmallCaps(java.lang.Boolean smallCaps)+
TextObjectsetSmallCaps in interface TextObjectsmallCaps - true for small caps, false for normal text, or null if not set.public java.lang.Boolean isLetterSpaced()+
TextObjectisLetterSpaced in interface TextObjecttrue for letter spaced text, false for normal text, or null if not set.public void setLetterSpaced(java.lang.Boolean letterSpaced)+
TextObjectsetLetterSpaced in interface TextObjectletterSpaced - true for letter spaced text, false for normal text, or null if not set.public java.lang.String getPrimaryLanguage()+
public void setPrimaryLanguage(java.lang.String lang)+
public java.lang.String composeText(boolean replaceTextContent, + boolean recursive)+
LowLevelTextContainercomposeText in interface LowLevelTextContainerreplaceTextContent - If set to true the text content of this object will be replaced by the composed text (only if the composed text is not empty)recursive - If set to true all lower levels of text objects are used for the compositionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/TextRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/TextRegion.html new file mode 100644 index 00000000..d1a84844 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/TextRegion.html @@ -0,0 +1,1421 @@ + + + + + +public class TextRegion +extends RegionImpl +implements TextObject, LowLevelTextContainer+
TEMP_ID_SUFFIX| Modifier | +Constructor and Description | +
|---|---|
protected |
+TextRegion(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ RegionContainer parentRegion) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addTextObject(LowLevelTextObject textObj)
+Adds a child text object
+ |
+
java.lang.String |
+composeText(boolean replaceTextContent,
+ boolean recursive)
+Composes the text for this object using the child text objects.
+ |
+
TextLine |
+createTextLine()
+Creates a child text line
+ |
+
TextLine |
+createTextLine(java.lang.String id)
+Creates a new text line object and adds it to this text region
+ |
+
java.lang.String |
+getBgColour() |
+
java.lang.Double |
+getConfidence()
+Returns the OCR confidence for the text content.
+ |
+
double |
+getFontSize() |
+
int |
+getKerning() |
+
int |
+getLeading() |
+
double |
+getOrientation() |
+
java.lang.String |
+getPlainText()
+Returns the plain text.
+ |
+
java.lang.String |
+getPrimaryLanguage() |
+
java.lang.String |
+getPrimaryScript() |
+
java.lang.String |
+getReadingDirection() |
+
double |
+getReadingOrientation() |
+
java.lang.String |
+getSecondaryLanguage() |
+
java.lang.String |
+getSecondaryScript() |
+
java.lang.String |
+getText()
+Returns the Unicode text.
+ |
+
java.lang.String |
+getTextColour() |
+
LowLevelTextObject |
+getTextObject(org.primaresearch.ident.Id id)
+Returns a child text object
+ |
+
LowLevelTextObject |
+getTextObject(int index)
+Returns a child text object
+ |
+
int |
+getTextObjectCount()
+Returns the number of child text objects
+ |
+
java.util.List<LowLevelTextObject> |
+getTextObjectsSorted()
+Returns a sorted list of all text objects (sorts by x or y position, depending on the object type).
+ |
+
java.lang.String |
+getTextType() |
+
ContentType |
+getType()
+Returns the type of this page content object
+ |
+
boolean |
+hasTextObjects()
+Checks if there child text objects
+ |
+
java.lang.Boolean |
+isBold()
+Bold text?
+ |
+
boolean |
+isIndented() |
+
java.lang.Boolean |
+isItalic()
+Italic text?
+ |
+
java.lang.Boolean |
+isLetterSpaced()
+Letter spaced (gaps between characters)?
+ |
+
boolean |
+isReverseVideo() |
+
java.lang.Boolean |
+isSmallCaps()
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
java.lang.Boolean |
+isStrikethrough()
+Strikethrough (line through text)?
+ |
+
java.lang.Boolean |
+isSubscript()
+Subscript (small letters below the baseline)?
+ |
+
java.lang.Boolean |
+isSuperscript()
+Superscript (small letters above the line of text)?
+ |
+
boolean |
+isTemporary()
+Checks if this is a temporary content object
+ |
+
java.lang.Boolean |
+isUnderlined()
+Underlined text?
+ |
+
void |
+removeTextObject(org.primaresearch.ident.Id id)
+Removes a child text object
+ |
+
void |
+removeTextObject(int index)
+Removes a child text object
+ |
+
void |
+setBgColour(java.lang.String colour) |
+
void |
+setBold(java.lang.Boolean bold)
+Bold text?
+ |
+
void |
+setConfidence(java.lang.Double confidence)
+Sets the OCR confidence for the text content.
+ |
+
void |
+setFontSize(double fontSize) |
+
void |
+setIndented(boolean indented) |
+
void |
+setItalic(java.lang.Boolean italic)
+Italic text?
+ |
+
void |
+setKerning(int kerning) |
+
void |
+setLeading(int leading) |
+
void |
+setLetterSpaced(java.lang.Boolean letterSpaced)
+Letter spaced (gaps between characters)?
+ |
+
void |
+setOrientation(double orientation) |
+
void |
+setPlainText(java.lang.String text)
+Sets the plain text.
+ |
+
void |
+setPrimaryLanguage(java.lang.String lang) |
+
void |
+setPrimarySkript(java.lang.String skript) |
+
void |
+setReadingDirection(java.lang.String direction) |
+
void |
+setReadingOrientation(double orientation) |
+
void |
+setReverseVideo(boolean reverseVideo) |
+
void |
+setSecondaryLanguage(java.lang.String lang) |
+
void |
+setSecondarySkript(java.lang.String skript) |
+
void |
+setSmallCaps(java.lang.Boolean smallCaps)
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
void |
+setStrikethrough(java.lang.Boolean strikethrough)
+Strikethrough (line through text)?
+ |
+
void |
+setSubscript(java.lang.Boolean subscript)
+Subscript (small letters below the baseline)?
+ |
+
void |
+setSuperscript(java.lang.Boolean superscript)
+Superscript (small letters above the line of text)?
+ |
+
void |
+setText(java.lang.String text)
+Sets the Unicode text.
+ |
+
void |
+setTextColour(java.lang.String colour) |
+
void |
+setTextType(java.lang.String type) |
+
void |
+setUnderlined(java.lang.Boolean underlined)
+Underlined text?
+ |
+
addRegion, getAttributes, getCoords, getId, getIdRegister, getParentRegion, getRegion, getRegionCount, hasRegions, removeRegion, setCoords, setId, setIdclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected TextRegion(ContentFactory contentFactory, + org.primaresearch.ident.IdRegister idRegister, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + RegionContainer parentRegion)+
public ContentType getType()+
ContentObjectgetType in interface ContentObjectgetType in class RegionImplpublic java.lang.String getText()+
TextObjectgetText in interface TextObjectpublic java.lang.String getPlainText()+
TextObjectgetPlainText in interface TextObjectpublic void setText(java.lang.String text)+
TextObjectsetText in interface TextObjectpublic void setPlainText(java.lang.String text)+
TextObjectsetPlainText in interface TextObjectpublic boolean hasTextObjects()+
LowLevelTextContainerhasTextObjects in interface LowLevelTextContainertrue if there are children, false if emptypublic int getTextObjectCount()+
LowLevelTextContainergetTextObjectCount in interface LowLevelTextContainerpublic LowLevelTextObject getTextObject(int index)+
LowLevelTextContainergetTextObject in interface LowLevelTextContainerindex - Positionpublic TextLine createTextLine()+
public TextLine createTextLine(java.lang.String id)+
id - Preferred ID for the text line (not guaranteed, check the returned line for the actual ID)public void addTextObject(LowLevelTextObject textObj)+
LowLevelTextContaineraddTextObject in interface LowLevelTextContainertextObj - Object to addpublic LowLevelTextObject getTextObject(org.primaresearch.ident.Id id)+
LowLevelTextContainergetTextObject in interface LowLevelTextContainerid - ID of childpublic void removeTextObject(int index) + throws java.lang.IndexOutOfBoundsException+
LowLevelTextContainerremoveTextObject in interface LowLevelTextContainerindex - Positionjava.lang.IndexOutOfBoundsException - Invalid indexpublic void removeTextObject(org.primaresearch.ident.Id id)+
LowLevelTextContainerremoveTextObject in interface LowLevelTextContainerid - ID of childpublic boolean isTemporary()+
ContentObjectisTemporary in interface ContentObjectisTemporary in class RegionImpltrue if temporary, false if normal content objectpublic java.lang.String getTextType()+
public void setTextType(java.lang.String type)+
public double getOrientation()+
public void setOrientation(double orientation)+
public java.lang.String getTextColour()+
public void setTextColour(java.lang.String colour)+
public java.lang.String getBgColour()+
public void setBgColour(java.lang.String colour)+
public boolean isReverseVideo()+
public void setReverseVideo(boolean reverseVideo)+
public double getFontSize()+
public void setFontSize(double fontSize)+
public int getLeading()+
public void setLeading(int leading)+
public int getKerning()+
public void setKerning(int kerning)+
public java.lang.String getReadingDirection()+
public void setReadingDirection(java.lang.String direction)+
public double getReadingOrientation()+
public void setReadingOrientation(double orientation)+
public boolean isIndented()+
public void setIndented(boolean indented)+
public java.lang.String getPrimaryLanguage()+
public void setPrimaryLanguage(java.lang.String lang)+
public java.lang.String getSecondaryLanguage()+
public void setSecondaryLanguage(java.lang.String lang)+
public java.lang.String getPrimaryScript()+
public void setPrimarySkript(java.lang.String skript)+
public java.lang.String getSecondaryScript()+
public void setSecondarySkript(java.lang.String skript)+
public java.util.List<LowLevelTextObject> getTextObjectsSorted()+
LowLevelTextContainergetTextObjectsSorted in interface LowLevelTextContainerpublic java.lang.Double getConfidence()+
TextObjectgetConfidence in interface TextObjectpublic void setConfidence(java.lang.Double confidence)+
TextObjectsetConfidence in interface TextObjectpublic java.lang.Boolean isBold()+
TextObjectisBold in interface TextObjecttrue for bold text, false for normal text, or null if not set.public void setBold(java.lang.Boolean bold)+
TextObjectsetBold in interface TextObjectbold - true for bold text, false for normal text, or null for 'not set'.public java.lang.Boolean isItalic()+
TextObjectisItalic in interface TextObjecttrue for italic text, false for normal text, or null if not set.public void setItalic(java.lang.Boolean italic)+
TextObjectsetItalic in interface TextObjectitalic - true for italic text, false for normal text, or null for 'not set'.public java.lang.Boolean isUnderlined()+
TextObjectisUnderlined in interface TextObjecttrue for underlined text, false for not underlined text, or null if not set.public void setUnderlined(java.lang.Boolean underlined)+
TextObjectsetUnderlined in interface TextObjectunderlined - true for underlined text, false for not underlined text, or null if not set.public java.lang.Boolean isSubscript()+
TextObjectisSubscript in interface TextObjecttrue for subscript, false for normal text, or null if not set.public void setSubscript(java.lang.Boolean subscript)+
TextObjectsetSubscript in interface TextObjectsubscript - true for subscript, false for normal text, or null if not set.public java.lang.Boolean isSuperscript()+
TextObjectisSuperscript in interface TextObjecttrue for superscript, false for normal text, or null if not set.public void setSuperscript(java.lang.Boolean superscript)+
TextObjectsetSuperscript in interface TextObjectsuperscript - true for superscript, false for normal text, or null if not set.public java.lang.Boolean isStrikethrough()+
TextObjectisStrikethrough in interface TextObjecttrue for strikethrough, false for normal text, or null if not set.public void setStrikethrough(java.lang.Boolean strikethrough)+
TextObjectsetStrikethrough in interface TextObjectstrikethrough - true for strikethrough, false for normal text, or null if not set.public java.lang.Boolean isSmallCaps()+
TextObjectisSmallCaps in interface TextObjecttrue for small caps, false for normal text, or null if not set.public void setSmallCaps(java.lang.Boolean smallCaps)+
TextObjectsetSmallCaps in interface TextObjectsmallCaps - true for small caps, false for normal text, or null if not set.public java.lang.Boolean isLetterSpaced()+
TextObjectisLetterSpaced in interface TextObjecttrue for letter spaced text, false for normal text, or null if not set.public void setLetterSpaced(java.lang.Boolean letterSpaced)+
TextObjectsetLetterSpaced in interface TextObjectletterSpaced - true for letter spaced text, false for normal text, or null if not set.public java.lang.String composeText(boolean replaceTextContent, + boolean recursive)+
LowLevelTextContainercomposeText in interface LowLevelTextContainerreplaceTextContent - If set to true the text content of this object will be replaced by the composed text (only if the composed text is not empty)recursive - If set to true all lower levels of text objects are used for the compositionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/Word.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/Word.html new file mode 100644 index 00000000..863e7d9a --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/Word.html @@ -0,0 +1,902 @@ + + + + + +public class Word +extends LowLevelTextObject +implements LowLevelTextContainer+
TEMP_ID_SUFFIX| Modifier | +Constructor and Description | +
|---|---|
protected |
+Word(ContentFactory contentFactory,
+ org.primaresearch.ident.IdRegister idRegister,
+ org.primaresearch.ident.Id id,
+ org.primaresearch.maths.geometry.Polygon coords,
+ org.primaresearch.shared.variable.VariableMap attributes,
+ LowLevelTextContainer parentLine) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addTextObject(LowLevelTextObject textObj)
+Adds a child text object
+ |
+
java.lang.String |
+composeText(boolean replaceTextContent,
+ boolean recursive)
+Composes the text for this object using the child text objects.
+ |
+
Glyph |
+createGlyph() |
+
Glyph |
+createGlyph(java.lang.String id)
+Creates a new glyph object and adds it to this word
+ |
+
java.lang.String |
+getLanguage() |
+
LowLevelTextObject |
+getTextObject(org.primaresearch.ident.Id id)
+Returns a child text object
+ |
+
LowLevelTextObject |
+getTextObject(int index)
+Returns a child text object
+ |
+
int |
+getTextObjectCount()
+Returns the number of child text objects
+ |
+
java.util.List<LowLevelTextObject> |
+getTextObjectsSorted()
+Returns a sorted list of all text objects (sorts by x or y position, depending on the object type).
+ |
+
ContentType |
+getType()
+Returns the type of this page content object
+ |
+
boolean |
+hasTextObjects()
+Checks if there child text objects
+ |
+
java.lang.Boolean |
+isBold()
+Bold text?
+ |
+
java.lang.Boolean |
+isItalic()
+Italic text?
+ |
+
java.lang.Boolean |
+isLetterSpaced()
+Letter spaced (gaps between characters)?
+ |
+
java.lang.Boolean |
+isSmallCaps()
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
java.lang.Boolean |
+isStrikethrough()
+Strikethrough (line through text)?
+ |
+
java.lang.Boolean |
+isSubscript()
+Subscript (small letters below the baseline)?
+ |
+
java.lang.Boolean |
+isSuperscript()
+Superscript (small letters above the line of text)?
+ |
+
java.lang.Boolean |
+isUnderlined()
+Underlined text?
+ |
+
void |
+removeTextObject(org.primaresearch.ident.Id id)
+Removes a child text object
+ |
+
void |
+removeTextObject(int index)
+Removes a child text object
+ |
+
void |
+setBold(java.lang.Boolean bold)
+Bold text?
+ |
+
void |
+setItalic(java.lang.Boolean italic)
+Italic text?
+ |
+
void |
+setLanguage(java.lang.String lang) |
+
void |
+setLetterSpaced(java.lang.Boolean letterSpaced)
+Letter spaced (gaps between characters)?
+ |
+
void |
+setSmallCaps(java.lang.Boolean smallCaps)
+Small caps (lower case characters appear as smaller capitals)?
+ |
+
void |
+setStrikethrough(java.lang.Boolean strikethrough)
+Strikethrough (line through text)?
+ |
+
void |
+setSubscript(java.lang.Boolean subscript)
+Subscript (small letters below the baseline)?
+ |
+
void |
+setSuperscript(java.lang.Boolean superscript)
+Superscript (small letters above the line of text)?
+ |
+
void |
+setUnderlined(java.lang.Boolean underlined)
+Underlined text?
+ |
+
getAttributes, getConfidence, getCoords, getId, getIdRegister, getParent, getPlainText, getText, isTemporary, setConfidence, setCoords, setId, setId, setParent, setPlainText, setTextclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitprotected Word(ContentFactory contentFactory, + org.primaresearch.ident.IdRegister idRegister, + org.primaresearch.ident.Id id, + org.primaresearch.maths.geometry.Polygon coords, + org.primaresearch.shared.variable.VariableMap attributes, + LowLevelTextContainer parentLine)+
public boolean hasTextObjects()+
LowLevelTextContainerhasTextObjects in interface LowLevelTextContainertrue if there are children, false if emptypublic int getTextObjectCount()+
LowLevelTextContainergetTextObjectCount in interface LowLevelTextContainerpublic LowLevelTextObject getTextObject(int index)+
LowLevelTextContainergetTextObject in interface LowLevelTextContainerindex - Positionpublic Glyph createGlyph()+
public Glyph createGlyph(java.lang.String id)+
id - Preferred ID for the glyph (not guaranteed, check the returned glyph for the actual ID)public void addTextObject(LowLevelTextObject textObj)+
LowLevelTextContaineraddTextObject in interface LowLevelTextContainertextObj - Object to addpublic ContentType getType()+
ContentObjectgetType in interface ContentObjectpublic LowLevelTextObject getTextObject(org.primaresearch.ident.Id id)+
LowLevelTextContainergetTextObject in interface LowLevelTextContainerid - ID of childpublic void removeTextObject(int index) + throws java.lang.IndexOutOfBoundsException+
LowLevelTextContainerremoveTextObject in interface LowLevelTextContainerindex - Positionjava.lang.IndexOutOfBoundsException - Invalid indexpublic void removeTextObject(org.primaresearch.ident.Id id)+
LowLevelTextContainerremoveTextObject in interface LowLevelTextContainerid - ID of childpublic java.util.List<LowLevelTextObject> getTextObjectsSorted()+
LowLevelTextContainergetTextObjectsSorted in interface LowLevelTextContainerpublic java.lang.Boolean isBold()+
TextObjectisBold in interface TextObjecttrue for bold text, false for normal text, or null if not set.public void setBold(java.lang.Boolean bold)+
TextObjectsetBold in interface TextObjectbold - true for bold text, false for normal text, or null for 'not set'.public java.lang.Boolean isItalic()+
TextObjectisItalic in interface TextObjecttrue for italic text, false for normal text, or null if not set.public void setItalic(java.lang.Boolean italic)+
TextObjectsetItalic in interface TextObjectitalic - true for italic text, false for normal text, or null for 'not set'.public java.lang.Boolean isUnderlined()+
TextObjectisUnderlined in interface TextObjecttrue for underlined text, false for not underlined text, or null if not set.public void setUnderlined(java.lang.Boolean underlined)+
TextObjectsetUnderlined in interface TextObjectunderlined - true for underlined text, false for not underlined text, or null if not set.public java.lang.Boolean isSubscript()+
TextObjectisSubscript in interface TextObjecttrue for subscript, false for normal text, or null if not set.public void setSubscript(java.lang.Boolean subscript)+
TextObjectsetSubscript in interface TextObjectsubscript - true for subscript, false for normal text, or null if not set.public java.lang.Boolean isSuperscript()+
TextObjectisSuperscript in interface TextObjecttrue for superscript, false for normal text, or null if not set.public void setSuperscript(java.lang.Boolean superscript)+
TextObjectsetSuperscript in interface TextObjectsuperscript - true for superscript, false for normal text, or null if not set.public java.lang.Boolean isStrikethrough()+
TextObjectisStrikethrough in interface TextObjecttrue for strikethrough, false for normal text, or null if not set.public void setStrikethrough(java.lang.Boolean strikethrough)+
TextObjectsetStrikethrough in interface TextObjectstrikethrough - true for strikethrough, false for normal text, or null if not set.public java.lang.Boolean isSmallCaps()+
TextObjectisSmallCaps in interface TextObjecttrue for small caps, false for normal text, or null if not set.public void setSmallCaps(java.lang.Boolean smallCaps)+
TextObjectsetSmallCaps in interface TextObjectsmallCaps - true for small caps, false for normal text, or null if not set.public java.lang.Boolean isLetterSpaced()+
TextObjectisLetterSpaced in interface TextObjecttrue for letter spaced text, false for normal text, or null if not set.public void setLetterSpaced(java.lang.Boolean letterSpaced)+
TextObjectsetLetterSpaced in interface TextObjectletterSpaced - true for letter spaced text, false for normal text, or null if not set.public java.lang.String getLanguage()+
public void setLanguage(java.lang.String lang)+
public java.lang.String composeText(boolean replaceTextContent, + boolean recursive)+
LowLevelTextContainercomposeText in interface LowLevelTextContainerreplaceTextContent - If set to true the text content of this object will be replaced by the composed text (only if the composed text is not empty)recursive - If set to true all lower levels of text objects are used for the compositionCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/DefaultTextRegionTypes.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/DefaultTextRegionTypes.html new file mode 100644 index 00000000..e1b63d8b --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/DefaultTextRegionTypes.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/Glyph.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/Glyph.html new file mode 100644 index 00000000..4dcdf9e4 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/Glyph.html @@ -0,0 +1,162 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Glyph |
+Word.createGlyph() |
+
Glyph |
+Word.createGlyph(java.lang.String id)
+Creates a new glyph object and adds it to this word
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/TextLine.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/TextLine.html new file mode 100644 index 00000000..fc43abc5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/TextLine.html @@ -0,0 +1,164 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
TextLine |
+TextRegion.createTextLine()
+Creates a child text line
+ |
+
TextLine |
+TextRegion.createTextLine(java.lang.String id)
+Creates a new text line object and adds it to this text region
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/TextRegion.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/TextRegion.html new file mode 100644 index 00000000..216bcf75 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/TextRegion.html @@ -0,0 +1,116 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/Word.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/Word.html new file mode 100644 index 00000000..c26e90e0 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/class-use/Word.html @@ -0,0 +1,162 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Word |
+TextLine.createWord() |
+
Word |
+TextLine.createWord(java.lang.String id)
+Creates a new word object and adds it to this text line.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-frame.html new file mode 100644 index 00000000..a1a5c8c3 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-frame.html @@ -0,0 +1,26 @@ + + + + + +| Interface | +Description | +
|---|---|
| DefaultTextRegionTypes | +
+ Collection of text region sub-types in compliance with the PAGE XML schema (version 2013-07-15).
+ |
+
| Class | +Description | +
|---|---|
| Glyph | +
+ Specialised low level text object representing glyphs within a page layout.
+ |
+
| TextLine | +
+ Specialised low level text object representing text lines within a page layout.
+ |
+
| TextRegion | +
+ Specialised layout region for text.
+ |
+
| Word | +
+ Specialised low level text object representing words within a page layout.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-tree.html new file mode 100644 index 00000000..5a0d38f5 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-tree.html @@ -0,0 +1,144 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-use.html new file mode 100644 index 00000000..d480af1c --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/impl/package-use.html @@ -0,0 +1,161 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Class and Description | +
|---|
| Glyph
+ Specialised low level text object representing glyphs within a page layout.
+ |
+
| TextLine
+ Specialised low level text object representing text lines within a page layout.
+ |
+
| Word
+ Specialised low level text object representing words within a page layout.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-frame.html new file mode 100644 index 00000000..82c6f84d --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-frame.html @@ -0,0 +1,25 @@ + + + + + +| Interface | +Description | +
|---|---|
| LowLevelTextContainer | +
+ Container for low-level text objects (text lines, words, glyphs).
+ |
+
| TextObject | +
+ Interface for objects with text content (e.g.
+ |
+
| Class | +Description | +
|---|---|
| LowLevelTextContainerImpl | +
+ Basic implementation of a low level text object container.
+ |
+
| LowLevelTextObject | +
+ Abstract class representing low level text objects such as text line, word and glyph.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-tree.html new file mode 100644 index 00000000..f825f134 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-tree.html @@ -0,0 +1,135 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-use.html new file mode 100644 index 00000000..1b924e48 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/physical/text/package-use.html @@ -0,0 +1,192 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Class and Description | +
|---|
| LowLevelTextContainer
+ Container for low-level text objects (text lines, words, glyphs).
+ |
+
| LowLevelTextObject
+ Abstract class representing low level text objects such as text line, word and glyph.
+ |
+
| TextObject
+ Interface for objects with text content (e.g.
+ |
+
| Class and Description | +
|---|
| LowLevelTextContainer
+ Container for low-level text objects (text lines, words, glyphs).
+ |
+
| LowLevelTextObject
+ Abstract class representing low level text objects such as text line, word and glyph.
+ |
+
| TextObject
+ Interface for objects with text content (e.g.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/GeometricObject.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/GeometricObject.html new file mode 100644 index 00000000..0839a656 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/GeometricObject.html @@ -0,0 +1,239 @@ + + + + + +public interface GeometricObject
+org.primaresearch.maths.geometry.Polygon getCoords()+
void setCoords(org.primaresearch.maths.geometry.Polygon coords)+
coords - A polygonCopyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/class-use/GeometricObject.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/class-use/GeometricObject.html new file mode 100644 index 00000000..d7344309 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/class-use/GeometricObject.html @@ -0,0 +1,397 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+GeometricObjectImpl
+Basic implementation of an object that can be located on the document page.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
GeometricObject |
+PageLayout.getBorder()
+Returns the page border object
+ |
+
GeometricObject |
+PageLayout.getPrintSpace()
+Returns the page print space object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+GeometricObjectPositionComparator.compare(GeometricObject obj1,
+ GeometricObject obj2) |
+
void |
+PageLayout.setBorder(GeometricObject border)
+Sets the page border.
+ |
+
void |
+PageLayout.setPrintSpace(GeometricObject printSpace)
+Sets the page print space.
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+ContentObject
+Represents physical page content objects (e.g.
+ |
+
interface |
+Region
+Layout region
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AdvertRegion
+Specialised implementation for advert regions.
+ |
+
class |
+ChartRegion
+Specialised implementation for chart regions.
+ |
+
class |
+ChemRegion
+Specialised implementation for chemical formula regions.
+ |
+
class |
+FrameRegion
+Specialised implementation for frame regions.
+ |
+
class |
+GraphicRegion
+Specialised implementation for graphic regions.
+ |
+
class |
+ImageRegion
+Specialised implementation for image regions.
+ |
+
class |
+LineDrawingRegion
+Specialised implementation for line drawing regions.
+ |
+
class |
+MathsRegion
+Specialised implementation for maths regions.
+ |
+
class |
+MusicRegion
+Specialised implementation for musical notation regions.
+ |
+
class |
+NoiseRegion
+Specialised implementation for noise regions.
+ |
+
class |
+RegionImpl
+Basic implementation for layout regions.
+ |
+
class |
+SeparatorRegion
+Specialised implementation for separator regions.
+ |
+
class |
+TableRegion
+Specialised implementation for table regions.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LowLevelTextObject
+Abstract class representing low level text objects such as text line, word and glyph.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Glyph
+Specialised low level text object representing glyphs within a page layout.
+ |
+
class |
+TextLine
+Specialised low level text object representing text lines within a page layout.
+ |
+
class |
+TextRegion
+Specialised layout region for text.
+ |
+
class |
+Word
+Specialised low level text object representing words within a page layout.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-frame.html new file mode 100644 index 00000000..217ab39c --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-frame.html @@ -0,0 +1,19 @@ + + + + + +| Interface | +Description | +
|---|---|
| GeometricObject | +
+ Interface for any object that can be located on a page (e.g.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-tree.html new file mode 100644 index 00000000..5aa9d8f6 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-tree.html @@ -0,0 +1,125 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-use.html new file mode 100644 index 00000000..7933443f --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/layout/shared/package-use.html @@ -0,0 +1,235 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| Class and Description | +
|---|
| GeometricObject
+ Interface for any object that can be located on a page (e.g.
+ |
+
| Class and Description | +
|---|
| GeometricObject
+ Interface for any object that can be located on a page (e.g.
+ |
+
| Class and Description | +
|---|
| GeometricObject
+ Interface for any object that can be located on a page (e.g.
+ |
+
| Class and Description | +
|---|
| GeometricObject
+ Interface for any object that can be located on a page (e.g.
+ |
+
| Class and Description | +
|---|
| GeometricObject
+ Interface for any object that can be located on a page (e.g.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-frame.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-frame.html new file mode 100644 index 00000000..f5f1fa47 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-frame.html @@ -0,0 +1,22 @@ + + + + + +| Class | +Description | +
|---|---|
| MetaData | +
+ Class for document metadata such as creation date, comments, ...
+ |
+
| Page | +
+ Central class representing one page of a document (e.g.
+ |
+
| Page.AlternativeImage | +
+ Alternative document page image (e.g.
+ |
+
| Page.MeasurementUnit | +
+ Measurement unit for coordinates.
++ Introduced to support ALTO XML files. |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-tree.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-tree.html new file mode 100644 index 00000000..87b5fffb --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-tree.html @@ -0,0 +1,132 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-use.html b/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-use.html new file mode 100644 index 00000000..1a3ce966 --- /dev/null +++ b/java/PrimaDla/apidoc/org/primaresearch/dla/page/package-use.html @@ -0,0 +1,267 @@ + + + + + +| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| org.primaresearch.dla.page.io | ++ |
| org.primaresearch.dla.page.io.xml | ++ |
| org.primaresearch.dla.page.io.xml.sax | ++ |
| org.primaresearch.dla.page.layout.converter | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| Class and Description | +
|---|
| MetaData
+ Class for document metadata such as creation date, comments, ...
+ |
+
| Page.AlternativeImage
+ Alternative document page image (e.g.
+ |
+
| Page.MeasurementUnit
+ Measurement unit for coordinates.
++ Introduced to support ALTO XML files. |
+
| Class and Description | +
|---|
| Page
+ Central class representing one page of a document (e.g.
+ |
+
| Class and Description | +
|---|
| Page
+ Central class representing one page of a document (e.g.
+ |
+
| Class and Description | +
|---|
| Page
+ Central class representing one page of a document (e.g.
+ |
+
| Class and Description | +
|---|
| Page
+ Central class representing one page of a document (e.g.
+ |
+
| Class and Description | +
|---|
| Page
+ Central class representing one page of a document (e.g.
+ |
+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/overview-frame.html b/java/PrimaDla/apidoc/overview-frame.html new file mode 100644 index 00000000..ef4e7524 --- /dev/null +++ b/java/PrimaDla/apidoc/overview-frame.html @@ -0,0 +1,32 @@ + + + + + ++ + diff --git a/java/PrimaDla/apidoc/overview-summary.html b/java/PrimaDla/apidoc/overview-summary.html new file mode 100644 index 00000000..be03afe8 --- /dev/null +++ b/java/PrimaDla/apidoc/overview-summary.html @@ -0,0 +1,178 @@ + + + + + +
| Package | +Description | +
|---|---|
| org.primaresearch.dla.page | ++ |
| org.primaresearch.dla.page.io | ++ |
| org.primaresearch.dla.page.io.xml | ++ |
| org.primaresearch.dla.page.io.xml.sax | ++ |
| org.primaresearch.dla.page.layout | ++ |
| org.primaresearch.dla.page.layout.converter | ++ |
| org.primaresearch.dla.page.layout.logical | ++ |
| org.primaresearch.dla.page.layout.physical | ++ |
| org.primaresearch.dla.page.layout.physical.impl | ++ |
| org.primaresearch.dla.page.layout.physical.shared | ++ |
| org.primaresearch.dla.page.layout.physical.text | ++ |
| org.primaresearch.dla.page.layout.physical.text.impl | ++ |
| org.primaresearch.dla.page.layout.shared | ++ |
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/overview-tree.html b/java/PrimaDla/apidoc/overview-tree.html new file mode 100644 index 00000000..19fba2a1 --- /dev/null +++ b/java/PrimaDla/apidoc/overview-tree.html @@ -0,0 +1,285 @@ + + + + + +Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/package-list b/java/PrimaDla/apidoc/package-list new file mode 100644 index 00000000..6718faa9 --- /dev/null +++ b/java/PrimaDla/apidoc/package-list @@ -0,0 +1,13 @@ +org.primaresearch.dla.page +org.primaresearch.dla.page.io +org.primaresearch.dla.page.io.xml +org.primaresearch.dla.page.io.xml.sax +org.primaresearch.dla.page.layout +org.primaresearch.dla.page.layout.converter +org.primaresearch.dla.page.layout.logical +org.primaresearch.dla.page.layout.physical +org.primaresearch.dla.page.layout.physical.impl +org.primaresearch.dla.page.layout.physical.shared +org.primaresearch.dla.page.layout.physical.text +org.primaresearch.dla.page.layout.physical.text.impl +org.primaresearch.dla.page.layout.shared diff --git a/java/PrimaDla/apidoc/resources/background.gif b/java/PrimaDla/apidoc/resources/background.gif new file mode 100644 index 00000000..f471940f Binary files /dev/null and b/java/PrimaDla/apidoc/resources/background.gif differ diff --git a/java/PrimaDla/apidoc/resources/tab.gif b/java/PrimaDla/apidoc/resources/tab.gif new file mode 100644 index 00000000..1a73a83b Binary files /dev/null and b/java/PrimaDla/apidoc/resources/tab.gif differ diff --git a/java/PrimaDla/apidoc/resources/titlebar.gif b/java/PrimaDla/apidoc/resources/titlebar.gif new file mode 100644 index 00000000..17443b3e Binary files /dev/null and b/java/PrimaDla/apidoc/resources/titlebar.gif differ diff --git a/java/PrimaDla/apidoc/resources/titlebar_end.gif b/java/PrimaDla/apidoc/resources/titlebar_end.gif new file mode 100644 index 00000000..3ad78d46 Binary files /dev/null and b/java/PrimaDla/apidoc/resources/titlebar_end.gif differ diff --git a/java/PrimaDla/apidoc/serialized-form.html b/java/PrimaDla/apidoc/serialized-form.html new file mode 100644 index 00000000..d969af64 --- /dev/null +++ b/java/PrimaDla/apidoc/serialized-form.html @@ -0,0 +1,203 @@ + + + + + +java.lang.String creator+
long created+
long lastModified+
java.lang.String comments+
java.lang.String name+
Copyright © 2014 PPImA Research Lab. All Rights Reserved.
+ + diff --git a/java/PrimaDla/apidoc/stylesheet.css b/java/PrimaDla/apidoc/stylesheet.css new file mode 100644 index 00000000..0aeaa97f --- /dev/null +++ b/java/PrimaDla/apidoc/stylesheet.css @@ -0,0 +1,474 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ +body { + background-color:#ffffff; + color:#353833; + font-family:Arial, Helvetica, sans-serif; + font-size:76%; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4c6b87; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4c6b87; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-size:1.3em; +} +h1 { + font-size:1.8em; +} +h2 { + font-size:1.5em; +} +h3 { + font-size:1.4em; +} +h4 { + font-size:1.3em; +} +h5 { + font-size:1.2em; +} +h6 { + font-size:1.1em; +} +ul { + list-style-type:disc; +} +code, tt { + font-size:1.2em; +} +dt code { + font-size:1.2em; +} +table tr td dt code { + font-size:1.2em; + vertical-align:top; +} +sup { + font-size:.6em; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:.8em; + z-index:200; + margin-top:-7px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + background-image:url(resources/titlebar.gif); + background-position:left top; + background-repeat:no-repeat; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:1em; + margin:0; +} +.topNav { + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; +} +.bottomNav { + margin-top:10px; + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; +} +.subNav { + background-color:#dee3e9; + border-bottom:1px solid #9eadc0; + float:left; + width:100%; + overflow:hidden; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding:3px 6px; +} +ul.subNavList li{ + list-style:none; + float:left; + font-size:90%; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; +} +.navBarCell1Rev { + background-image:url(resources/tab.gif); + background-color:#a88834; + color:#FFFFFF; + margin: auto 5px; + border:1px solid #c9aa44; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader h1 { + font-size:1.3em; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 25px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:1.2em; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + margin:0 0 6px -8px; + padding:2px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + margin:0 0 6px -8px; + padding:2px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:1.0em; +} +.indexContainer h2 { + font-size:1.1em; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:1.1em; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:10px 0 10px 20px; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:25px; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #9eadc0; + background-color:#f9f9f9; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:1px solid #9eadc0; + border-top:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; + border-bottom:1px solid #9eadc0; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.contentContainer table, .classUseContainer table, .constantValuesContainer table { + border-bottom:1px solid #9eadc0; + width:100%; +} +.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table { + width:100%; +} +.contentContainer .description table, .contentContainer .details table { + border-bottom:none; +} +.contentContainer ul li table th.colOne, .contentContainer ul li table th.colFirst, .contentContainer ul li table th.colLast, .classUseContainer ul li table th, .constantValuesContainer ul li table th, .contentContainer ul li table td.colOne, .contentContainer ul li table td.colFirst, .contentContainer ul li table td.colLast, .classUseContainer ul li table td, .constantValuesContainer ul li table td{ + vertical-align:top; + padding-right:20px; +} +.contentContainer ul li table th.colLast, .classUseContainer ul li table th.colLast,.constantValuesContainer ul li table th.colLast, +.contentContainer ul li table td.colLast, .classUseContainer ul li table td.colLast,.constantValuesContainer ul li table td.colLast, +.contentContainer ul li table th.colOne, .classUseContainer ul li table th.colOne, +.contentContainer ul li table td.colOne, .classUseContainer ul li table td.colOne { + padding-right:3px; +} +.overviewSummary caption, .packageSummary caption, .contentContainer ul.blockList li.blockList caption, .summary caption, .classUseContainer caption, .constantValuesContainer caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#FFFFFF; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + margin:0px; +} +caption a:link, caption a:hover, caption a:active, caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span { + white-space:nowrap; + padding-top:8px; + padding-left:8px; + display:block; + float:left; + background-image:url(resources/titlebar.gif); + height:18px; +} +.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd { + width:10px; + background-image:url(resources/titlebar_end.gif); + background-repeat:no-repeat; + background-position:top right; + position:relative; + float:left; +} +ul.blockList ul.blockList li.blockList table { + margin:0 0 12px 0px; + width:100%; +} +.tableSubHeadingColor { + background-color: #EEEEFF; +} +.altColor { + background-color:#eeeeef; +} +.rowColor { + background-color:#ffffff; +} +.overviewSummary td, .packageSummary td, .contentContainer ul.blockList li.blockList td, .summary td, .classUseContainer td, .constantValuesContainer td { + text-align:left; + padding:3px 3px 3px 7px; +} +th.colFirst, th.colLast, th.colOne, .constantValuesContainer th { + background:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + text-align:left; + padding:3px 3px 3px 7px; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +td.colFirst, th.colFirst { + border-left:1px solid #9eadc0; + white-space:nowrap; +} +td.colLast, th.colLast { + border-right:1px solid #9eadc0; +} +td.colOne, th.colOne { + border-right:1px solid #9eadc0; + border-left:1px solid #9eadc0; +} +table.overviewSummary { + padding:0px; + margin-left:0px; +} +table.overviewSummary td.colFirst, table.overviewSummary th.colFirst, +table.overviewSummary td.colOne, table.overviewSummary th.colOne { + width:25%; + vertical-align:middle; +} +table.packageSummary td.colFirst, table.overviewSummary th.colFirst { + width:25%; + vertical-align:middle; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:.9em; +} +.block { + display:block; + margin:3px 0 0 0; +} +.strong { + font-weight:bold; +} diff --git a/java/PrimaDla/src/org/primaresearch/dla/PrimaDla.gwt.xml b/java/PrimaDla/src/org/primaresearch/dla/PrimaDla.gwt.xml new file mode 100644 index 00000000..649a8a19 --- /dev/null +++ b/java/PrimaDla/src/org/primaresearch/dla/PrimaDla.gwt.xml @@ -0,0 +1,26 @@ + +DATE_FORMAT constant
+ */
+ public String getFormattedCreationTime() {
+ return DATE_FORMAT.format(new Date(created));
+ }
+
+ /**
+ * Returns the creation date/time
+ * @return Date object
+ */
+ public Date getCreationTime() {
+ return new Date(created);
+ }
+
+ /**
+ * Returns the modification date/time
+ * @return Date and time formatted according to the DATE_FORMAT constant
+ */
+ public String getFormattedLastModificationTime() {
+ return DATE_FORMAT.format(new Date(lastModified));
+ }
+
+ /**
+ * Returns the modification date/time
+ * @return Date object
+ */
+ public Date getLastModificationTime() {
+ return new Date(lastModified);
+ }
+
+ /**
+ * Sets the creation date/time
+ * @param d Date object
+ */
+ public void setCreationTime(Date d) {
+ created = d.getTime();
+ }
+
+ /**
+ * Sets the modification date/time
+ * @param d Date object
+ */
+ public void setLastModifiedTime(Date d) {
+ lastModified = d.getTime();
+ }
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/Page.java b/java/PrimaDla/src/org/primaresearch/dla/page/Page.java
new file mode 100644
index 00000000..310119bc
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/Page.java
@@ -0,0 +1,268 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.primaresearch.dla.page.io.xml.PageXmlInputOutput;
+import org.primaresearch.dla.page.layout.PageLayout;
+import org.primaresearch.dla.page.layout.converter.ConversionMessage;
+import org.primaresearch.dla.page.layout.converter.ConverterHub;
+import org.primaresearch.dla.page.layout.physical.AttributeContainer;
+import org.primaresearch.dla.page.layout.physical.AttributeFactory;
+import org.primaresearch.dla.page.layout.physical.ContentFactory;
+import org.primaresearch.dla.page.layout.physical.DefaultAttributeFactory;
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.ident.IdRegister.InvalidIdException;
+import org.primaresearch.ident.XmlIdRegister;
+import org.primaresearch.io.FormatModel;
+import org.primaresearch.io.FormatVersion;
+import org.primaresearch.shared.variable.VariableMap;
+
+/**
+ * Central class representing one page of a document (e.g. a book page).
+ *
+ * @author Christian Clausner
+ */
+public class Page implements AttributeContainer {
+
+ private PageLayout layout;
+ private ContentFactory contentFactory;
+ private IdRegister idRegister;
+ private MetaData metaData;
+ private String imageFilename;
+ private Id gtsId = null;
+ private FormatVersion formatVersion = null;
+
+ private VariableMap attributes;
+
+ private ListXmlInputOutput.postProcessPage(...)
+ * to scale all coordinates using the image information.
+ */
+ public static class MeasurementUnit {
+ public static final MeasurementUnit PIXEL = new MeasurementUnit("pixel", 0.0);
+ /** One tenth of a mm */
+ public static final MeasurementUnit MM_BY_10 = new MeasurementUnit("mm10", 254.0);
+ /** 1200th of an inch */
+ public static final MeasurementUnit INCH_BY_1200 = new MeasurementUnit("inch1200", 1200.0);
+
+ private String name;
+ private double discreteValuesPerInch;
+
+ public MeasurementUnit(String name, double discreteValuesPerInch) {
+ this.name = name;
+ this.discreteValuesPerInch = discreteValuesPerInch;
+ }
+
+ public double getDiscreteValuesPerInch() {
+ return discreteValuesPerInch;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ if (other == null || !(other instanceof MeasurementUnit))
+ return false;
+ return name.equals(((MeasurementUnit)other).getName());
+ }
+ }
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/FileInput.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/FileInput.java
new file mode 100644
index 00000000..d44e2e67
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/FileInput.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io;
+
+import java.io.File;
+
+/**
+ * Input source implementation for files
+ *
+ * @author Christian Clausner
+ *
+ */
+public class FileInput implements InputSource {
+
+
+ private File file;
+
+ public FileInput(File file) {
+ this.file = file;
+ }
+
+ public File getFile() {
+ return file;
+ }
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/FileTarget.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/FileTarget.java
new file mode 100644
index 00000000..c4b0bad5
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/FileTarget.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io;
+
+import java.io.File;
+
+/**
+ * OutputTarget implementation for files.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class FileTarget implements OutputTarget {
+
+ private File file;
+
+ public FileTarget(File file) {
+ this.file = file;
+ }
+
+ public File getFile() {
+ return file;
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/InputSource.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/InputSource.java
new file mode 100644
index 00000000..aabc69f5
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/InputSource.java
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io;
+
+/**
+ * Interface for input sources such as files or URLs.
+ *
+ * @author Christian Clausner
+ *
+ */
+public interface InputSource {
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/OutputTarget.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/OutputTarget.java
new file mode 100644
index 00000000..b1172c85
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/OutputTarget.java
@@ -0,0 +1,26 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io;
+
+/**
+ * Interface for output targets (e.g. files).
+ *
+ * @author Christian Clausner
+ *
+ */
+public interface OutputTarget {
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/PageReader.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/PageReader.java
new file mode 100644
index 00000000..e4a74ddd
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/PageReader.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io;
+
+import org.primaresearch.dla.page.Page;
+import org.primaresearch.io.UnsupportedFormatVersionException;
+import org.primaresearch.io.xml.XmlModelAndValidatorProvider.UnsupportedSchemaVersionException;
+
+/**
+ * Reader interface for PAGE.
+ *
+ * @author Christian Clausner
+ *
+ */
+public interface PageReader {
+
+ /**
+ * Reads a PAGE input source and returns a Page object.
+ * @param source Input source of some kind (e.g. FileInput).
+ * @return Page object
+ * @throws UnsupportedSchemaVersionException
+ */
+ public Page read(InputSource source) throws UnsupportedFormatVersionException;
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/PageWriter.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/PageWriter.java
new file mode 100644
index 00000000..3743ce7f
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/PageWriter.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io;
+
+import org.primaresearch.dla.page.Page;
+import org.primaresearch.io.UnsupportedFormatVersionException;
+
+/**
+ * Interface for writing PAGE.
+ *
+ * @author Christian Clausner
+ *
+ */
+public interface PageWriter {
+
+ /**
+ * Writes the given Page object to an output target.
+ *
+ * @return Returns true if written successfully, false otherwise.
+ */
+ public boolean write(Page page, OutputTarget target) throws UnsupportedFormatVersionException;
+
+ /**
+ * Validates the given page object against the format it is set to.
+ *
+ * @return Returns true if valid, false otherwise.
+ */
+ public boolean validate(Page page) throws UnsupportedFormatVersionException;
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/UrlInput.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/UrlInput.java
new file mode 100644
index 00000000..7531854e
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/UrlInput.java
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io;
+
+import java.net.URL;
+
+/**
+ * InputSouce implementation for URLs.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class UrlInput implements InputSource {
+
+ private URL url;
+
+ public UrlInput(URL url) {
+ this.url = url;
+ }
+
+ public URL getUrl() {
+ return url;
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/xml/DefaultXmlNames.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/xml/DefaultXmlNames.java
new file mode 100644
index 00000000..95de0c91
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/xml/DefaultXmlNames.java
@@ -0,0 +1,169 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io.xml;
+
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+import org.primaresearch.dla.page.layout.physical.shared.LowLevelTextType;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+
+/**
+ * Class containing hard coded XML element and attribute names for the PAGE format.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class DefaultXmlNames implements XmlNameProvider {
+ public static final String ELEMENT_PcGts = "PcGts";
+ public static final String ELEMENT_Page = "Page";
+ public static final String ELEMENT_TextRegion = "TextRegion";
+ public static final String ELEMENT_ImageRegion = "ImageRegion";
+ public static final String ELEMENT_LineDrawingRegion = "LineDrawingRegion";
+ public static final String ELEMENT_GraphicRegion = "GraphicRegion";
+ public static final String ELEMENT_TableRegion = "TableRegion";
+ public static final String ELEMENT_ChartRegion = "ChartRegion";
+ public static final String ELEMENT_SeparatorRegion = "SeparatorRegion";
+ public static final String ELEMENT_MathsRegion = "MathsRegion";
+ public static final String ELEMENT_NoiseRegion = "NoiseRegion";
+ public static final String ELEMENT_FrameRegion = "FrameRegion";
+ public static final String ELEMENT_UnknownRegion = "UnknownRegion";
+ public static final String ELEMENT_AdvertRegion = "AdvertRegion";
+ public static final String ELEMENT_ChemRegion = "ChemRegion";
+ public static final String ELEMENT_MusicRegion = "MusicRegion";
+
+ public static final String ELEMENT_Border = "Border";
+ public static final String ELEMENT_ReadingOrder = "ReadingOrder";
+ public static final String ELEMENT_RegionRef = "RegionRef";
+ public static final String ELEMENT_UnorderedGroup = "UnorderedGroup";
+ public static final String ELEMENT_OrderedGroup = "OrderedGroup";
+ public static final String ELEMENT_RegionRefIndexed = "RegionRefIndexed";
+ public static final String ELEMENT_UnorderedGroupIndexed = "UnorderedGroupIndexed";
+ public static final String ELEMENT_OrderedGroupIndexed = "OrderedGroupIndexed";
+ public static final String ELEMENT_Layers = "Layers";
+ public static final String ELEMENT_Layer = "Layer";
+ public static final String ELEMENT_PrintSpace = "PrintSpace";
+
+ public static final String ELEMENT_Coords = "Coords";
+ public static final String ELEMENT_Point = "Point";
+ public static final String ELEMENT_TextEquiv = "TextEquiv";
+ public static final String ELEMENT_TextLine = "TextLine";
+ public static final String ELEMENT_Word = "Word";
+ public static final String ELEMENT_Glyph = "Glyph";
+ public static final String ELEMENT_PlainText = "PlainText";
+ public static final String ELEMENT_Unicode = "Unicode";
+ public static final String ELEMENT_Baseline = "Baseline";
+
+ public static final String ELEMENT_Metadata = "Metadata";
+ public static final String ELEMENT_Creator = "Creator";
+ public static final String ELEMENT_Created = "Created";
+ public static final String ELEMENT_LastChange = "LastChange";
+ public static final String ELEMENT_Comments = "Comments";
+
+ public static final String ELEMENT_AlternativeImage = "AlternativeImage";
+ public static final String ELEMENT_Relations = "Relations";
+ public static final String ELEMENT_Relation = "Relation";
+ public static final String ELEMENT_TextStyle = "TextStyle";
+
+
+ public static final String ATTR_pcGtsId = "pcGtsId";
+ public static final String ATTR_imageFilename = "imageFilename";
+ public static final String ATTR_imageWidth = "imageWidth";
+ public static final String ATTR_imageHeight = "imageHeight";
+ public static final String ATTR_id = "id";
+ public static final String ATTR_x = "x";
+ public static final String ATTR_y = "y";
+ public static final String ATTR_orientation = "orientation";
+ public static final String ATTR_readingOrientation = "readingOrientation";
+ public static final String ATTR_readingDirection = "readingDirection";
+ public static final String ATTR_leading = "leading";
+ public static final String ATTR_kerning = "kerning";
+ public static final String ATTR_fontSize = "fontSize";
+ public static final String ATTR_type = "type";
+ public static final String ATTR_textColour = "textColour";
+ public static final String ATTR_bgColour = "bgColour";
+ public static final String ATTR_reverseVideo = "reverseVideo";
+ public static final String ATTR_indented = "indented";
+ public static final String ATTR_primaryLanguage = "primaryLanguage";
+ public static final String ATTR_secondaryLanguage = "secondaryLanguage";
+ public static final String ATTR_language = "language";
+ public static final String ATTR_primaryScript = "primaryScript";
+ public static final String ATTR_secondaryScript = "secondaryScript";
+ public static final String ATTR_colourDepth = "colourDepth";
+ public static final String ATTR_embText = "embText";
+ public static final String ATTR_penColour = "penColour";
+ public static final String ATTR_numColours = "numColours";
+ public static final String ATTR_rows = "rows";
+ public static final String ATTR_columns = "columns";
+ public static final String ATTR_lineColour = "lineColour";
+ public static final String ATTR_lineSeparators = "lineSeparators";
+ public static final String ATTR_colour = "colour";
+ public static final String ATTR_borderPresent = "borderPresent";
+ public static final String ATTR_symbol = "symbol";
+ public static final String ATTR_ligature = "ligature";
+ public static final String ATTR_regionRef = "regionRef";
+ public static final String ATTR_index = "index";
+ public static final String ATTR_zIndex = "zIndex";
+ public static final String ATTR_points = "points";
+ public static final String ATTR_caption = "caption";
+ public static final String ATTR_conf = "conf";
+ public static final String ATTR_custom = "custom";
+ public static final String ATTR_comments = "comments";
+ public static final String ATTR_filename = "filename";
+ public static final String ATTR_bold = "bold";
+ public static final String ATTR_italic = "italic";
+ public static final String ATTR_underlined = "underlined";
+ public static final String ATTR_strikethrough = "strikethrough";
+ public static final String ATTR_subscript = "subscript";
+ public static final String ATTR_superscript = "superscript";
+ public static final String ATTR_smallCaps = "smallCaps";
+ public static final String ATTR_letterSpaced = "letterSpaced";
+
+ @Override
+ public String getXmlName(ContentType type) {
+ if (type == RegionType.ChartRegion)
+ return ELEMENT_ChartRegion;
+ if (type == RegionType.GraphicRegion)
+ return ELEMENT_GraphicRegion;
+ if (type == RegionType.ImageRegion)
+ return ELEMENT_ImageRegion;
+ if (type == RegionType.LineDrawingRegion)
+ return ELEMENT_LineDrawingRegion;
+ if (type == RegionType.MathsRegion)
+ return ELEMENT_MathsRegion;
+ if (type == RegionType.NoiseRegion)
+ return ELEMENT_NoiseRegion;
+ if (type == RegionType.SeparatorRegion)
+ return ELEMENT_SeparatorRegion;
+ if (type == RegionType.AdvertRegion)
+ return ELEMENT_AdvertRegion;
+ if (type == RegionType.ChemRegion)
+ return ELEMENT_ChemRegion;
+ if (type == RegionType.MusicRegion)
+ return ELEMENT_MusicRegion;
+ if (type == RegionType.TableRegion)
+ return ELEMENT_TableRegion;
+ if (type == RegionType.TextRegion)
+ return ELEMENT_TextRegion;
+ if (type == RegionType.UnknownRegion)
+ return ELEMENT_UnknownRegion;
+ if (type == LowLevelTextType.TextLine)
+ return ELEMENT_TextLine;
+ if (type == LowLevelTextType.Word)
+ return ELEMENT_Word;
+ if (type == LowLevelTextType.Glyph)
+ return ELEMENT_Glyph;
+ return type.getName();
+ }
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/io/xml/MetsMultiPageReader.java b/java/PrimaDla/src/org/primaresearch/dla/page/io/xml/MetsMultiPageReader.java
new file mode 100644
index 00000000..2244bdb2
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/io/xml/MetsMultiPageReader.java
@@ -0,0 +1,168 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.io.xml;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.xml.parsers.SAXParser;
+import javax.xml.parsers.SAXParserFactory;
+
+import org.primaresearch.dla.page.io.FileInput;
+import org.primaresearch.dla.page.io.InputSource;
+import org.primaresearch.dla.page.io.UrlInput;
+import org.primaresearch.io.xml.IOError;
+import org.xml.sax.Attributes;
+import org.xml.sax.SAXException;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.DefaultHandler;
+
+
+/**
+ * Reader for multiple page file defined in METS XML format.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class MetsMultiPageReader {
+
+ private SAXParser parser;
+ private SaxMetsHandler metsHandler = null;
+ private PageErrorHandler lastErrors;
+
+ public MetsMultiPageReader() {
+ createParser();
+ }
+
+ public Listtrue if errors were registered
+ */
+ public boolean hasErrors() {
+ return !errors.isEmpty();
+ }
+
+ /**
+ * Checks if there were warnings
+ * @return true if warnings were registered
+ */
+ public boolean hasWarnings() {
+ return !warnings.isEmpty();
+ }
+
+ /**
+ * Returns all registered errors
+ * @return List of error objects
+ */
+ public Listtrue to sort objects left-to-right or to false to sort top-to-bottom
+ */
+ private GeometricObjectPositionComparator(boolean sortByX) {
+ this.sortByX = sortByX;
+ }
+
+ /**
+ * Creates a comparator
+ * @param sortByX Set to true to sort objects left-to-right or to false to sort top-to-bottom
+ * @return Comparator object
+ */
+ public static GeometricObjectPositionComparator getInstance(boolean sortByX) {
+ if (sortByX) {
+ if (instanceToSortByX == null)
+ instanceToSortByX = new GeometricObjectPositionComparator(true);
+ return instanceToSortByX;
+ }
+ else { //sort by y
+ if (instanceToSortByY == null)
+ instanceToSortByY = new GeometricObjectPositionComparator(false);
+ return instanceToSortByY;
+ }
+ }
+
+
+ @Override
+ public int compare(GeometricObject obj1, GeometricObject obj2) {
+ if (sortByX) {
+ int x1 = obj1.getCoords().getBoundingBox().left;
+ int x2 = obj2.getCoords().getBoundingBox().left;
+ return x1 - x2;
+ } else {
+ int y1 = obj1.getCoords().getBoundingBox().top;
+ int y2 = obj2.getCoords().getBoundingBox().top;
+ return y1 - y2;
+ }
+ }
+
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/PageLayout.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/PageLayout.java
new file mode 100644
index 00000000..391cf039
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/PageLayout.java
@@ -0,0 +1,638 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.HashSet;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Set;
+
+import org.primaresearch.collections.IndexedMap;
+import org.primaresearch.collections.IndexedMapImpl;
+import org.primaresearch.dla.page.layout.logical.ContentObjectRelation;
+import org.primaresearch.dla.page.layout.logical.ContentObjectRelation.RelationType;
+import org.primaresearch.dla.page.layout.logical.Group;
+import org.primaresearch.dla.page.layout.logical.GroupMember;
+import org.primaresearch.dla.page.layout.logical.Layer;
+import org.primaresearch.dla.page.layout.logical.Layers;
+import org.primaresearch.dla.page.layout.logical.ReadingOrder;
+import org.primaresearch.dla.page.layout.logical.RegionRef;
+import org.primaresearch.dla.page.layout.logical.Relations;
+import org.primaresearch.dla.page.layout.physical.ContentFactory;
+import org.primaresearch.dla.page.layout.physical.ContentIterator;
+import org.primaresearch.dla.page.layout.physical.ContentObject;
+import org.primaresearch.dla.page.layout.physical.Region;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.impl.LowLevelTextObjectIterator;
+import org.primaresearch.dla.page.layout.physical.impl.RegionIterator;
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+import org.primaresearch.dla.page.layout.physical.shared.LowLevelTextType;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextContainer;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextObject;
+import org.primaresearch.dla.page.layout.shared.GeometricObject;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister.InvalidIdException;
+import org.primaresearch.maths.geometry.Dimension;
+import org.primaresearch.maths.geometry.Polygon;
+
+/**
+ * Class representing the layout and text content of a document page.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class PageLayout {
+
+ private Dimension size = new Dimension();
+
+ private GeometricObject border = null;
+ private GeometricObject printSpace = null;
+
+ private ContentFactory contentFactory;
+
+ private IndexedMaptrue the ID will be removed from the ID register and is free to be used again
+ * @throws IndexOutOfBoundsException
+ */
+ public void removeRegion(int index, boolean unregisterId) {
+ Region reg = regions.removeAt(index);
+ if (unregisterId && reg != null)
+ this.contentFactory.getIdRegister().unregisterId(reg.getId());
+ }
+
+ /**
+ * Returns a sorted list of all regions. The sorting is primarily done by reading order and secondarily by y position.
+ * @return List of region objects
+ */
+ public Listnull for an iterator that includes all regions.
+ * @param layer Restrict the iterator to this layer (use null for no restriction)
+ * @return The iterator
+ */
+ public ContentIterator iterator(ContentType contentType, Layer layer) {
+ if (contentType == null || contentType instanceof RegionType)
+ return new RegionIterator(this, (RegionType)contentType, layer);
+ else if (contentType instanceof LowLevelTextType)
+ return new LowLevelTextObjectIterator(this, (LowLevelTextType)contentType, layer);
+ throw new IllegalArgumentException("Unsupported content type for iterator");
+ }
+
+ /**
+ * Creates a comparator using the bounding box area of content objects
+ * @return Comparator object
+ */
+ private static ComparatorCONVERSION_... constants)
+ */
+ public ConversionMessage(String text, int code) {
+ this.text = text;
+ }
+
+ /**
+ * Returns the message content
+ */
+ public String getText() {
+ return text;
+ }
+
+ /**
+ * Returns the message code (see CONVERSION_... constants)
+ */
+ public int getCode() {
+ return code;
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/converter/ConverterHub.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/converter/ConverterHub.java
new file mode 100644
index 00000000..699fcdf4
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/converter/ConverterHub.java
@@ -0,0 +1,226 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.converter;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.primaresearch.dla.page.Page;
+import org.primaresearch.dla.page.layout.PageLayout;
+import org.primaresearch.dla.page.layout.physical.ContentObject;
+import org.primaresearch.dla.page.layout.physical.Region;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextContainer;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextObject;
+import org.primaresearch.io.FormatModel;
+import org.primaresearch.io.FormatVersion;
+import org.primaresearch.shared.variable.Variable;
+import org.primaresearch.shared.variable.VariableMap;
+
+/**
+ * Central access point for converting page objects to specific format versions.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class ConverterHub {
+
+ /** Singleton instance */
+ private static ConverterHub instance = null;
+
+
+ /** Registered converters */
+ private Mapnull for root)
+ * @param canHaveGroupsAsChildren Set to true to allow child groups
+ */
+ Group(PageLayout layout, IdRegister idRegister, ContentFactory contentFactory, Id id, Group parentGroup, boolean canHaveGroupsAsChildren) {
+ this.layout = layout;
+ this.idRegister = idRegister;
+ this.contentFactory = contentFactory;
+ this.id = id;
+ this.parentGroup = parentGroup;
+ this.canHaveGroupsAsChildren = canHaveGroupsAsChildren;
+ }
+
+ /**
+ * Returns the parent of this group or null if it is a root group
+ */
+ public Group getParent() {
+ return parentGroup;
+ }
+
+ @Override
+ public Id getId() {
+ return id;
+ }
+
+ /**
+ * Returns the caption (display name)
+ */
+ public String getCaption() {
+ return caption;
+ }
+
+ /**
+ * Sets the caption (display name)
+ */
+ public void setCaption(String caption) {
+ this.caption = caption;
+ }
+
+ /**
+ * Returns the 'ordered' state of this group
+ * @return true if an ordered group; false if an unordered group
+ */
+ public boolean isOrdered() {
+ return ordered;
+ }
+
+ /**
+ * Sets the 'ordered' state of this group
+ * @param ordered Set to true for an ordered group or false for an unordered group
+ */
+ public void setOrdered(boolean ordered) {
+ this.ordered = ordered;
+ }
+
+ /**
+ * Returns the size of this group
+ * @return Number of members
+ */
+ public int getSize() {
+ return members.size();
+ }
+
+ /**
+ * Returns the group member at the given position
+ * @param index Position
+ * @return Group member object
+ */
+ public GroupMember getMember(int index) {
+ return members.get(index);
+ }
+
+ /**
+ * Creates a group and adds it as child to this group
+ * @return The new group
+ * @throws Exception The group is not allowed to have children
+ */
+ public Group createChildGroup() throws Exception {
+ if (!canHaveGroupsAsChildren)
+ throw new Exception("");
+ Group group = new Group(layout, idRegister, contentFactory, idRegister.generateId("g"), this, canHaveGroupsAsChildren);
+ members.add(group);
+ return group;
+ }
+
+ /**
+ * Adds a reference to a region as group member
+ * @param id Region ID
+ */
+ public void addRegionRef(String id) {
+ try {
+ members.add(new RegionRef(this, contentFactory.getIdRegister().getId(id)));
+ } catch (InvalidIdException e) {
+ e.printStackTrace();
+ }
+ }
+
+ /**
+ * Removes a reference to a region
+ * @param id Region ID
+ */
+ public void removeRegionRef(String id) {
+ if (members != null) {
+ GroupMember toRemove = null;
+ for (Iteratortrue if empty, false otherwise
+ */
+ public boolean isEmpty() {
+ return relations.isEmpty();
+ }
+
+ /**
+ * Adds a relation to this container.
+ * @param relation Relation object to add
+ */
+ public void addRelation(ContentObjectRelation relation) {
+ Mapnull if the type is not supported
+ */
+ public ContentObject createContent(ContentType type) {
+
+ //Text regions are special
+ if (RegionType.TextRegion.equals(type))
+ return createTextRegion();
+
+ if (LowLevelTextType.TextLine.equals(type))
+ return createTextLine();
+
+ if (LowLevelTextType.Word.equals(type))
+ return createWord();
+
+ if (LowLevelTextType.Glyph.equals(type))
+ return createGlyph();
+
+ //All other regions
+ if (type instanceof RegionType) {
+ Id id = null;
+ try {
+ id = idRegister.generateId("r");
+ } catch (InvalidIdException e) {
+ }
+ Region ret = null;
+ if (RegionType.ImageRegion.equals(type))
+ ret = new ImageRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.GraphicRegion.equals(type))
+ ret = new GraphicRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.LineDrawingRegion.equals(type))
+ ret = new LineDrawingRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.ChartRegion.equals(type))
+ ret = new ChartRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.SeparatorRegion.equals(type))
+ ret = new SeparatorRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.MathsRegion.equals(type))
+ ret = new MathsRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.AdvertRegion.equals(type))
+ ret = new AdvertRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.ChemRegion.equals(type))
+ ret = new ChemRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.MusicRegion.equals(type))
+ ret = new MusicRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.TableRegion.equals(type))
+ ret = new TableRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ //else if (type == RegionType.FrameRegion)
+ // ret = new FrameRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else if (RegionType.NoiseRegion.equals(type))
+ ret = new NoiseRegion(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ else //Generic
+ ret = new RegionItem(idRegister, (RegionType)type, id, new Polygon(), createAttributes(type), null);
+ return ret;
+ }
+ return null;
+ }
+
+ private VariableMap createAttributes(ContentType contentType) {
+ return attributeFactory.createAttributes(contentType);
+ }
+
+ /**
+ * Creates a reading order object
+ * @param layout Page layout the reading order is intended for
+ * @return The reading order object
+ */
+ public ReadingOrder createReadingOrder(PageLayout layout) {
+ return new ReadingOrder(layout, idRegister, this);
+ }
+
+ /**
+ * Creates a layer container
+ * @param layout Page layout the layer container is intended for
+ * @return Layers object
+ */
+ public Layers createLayers(PageLayout layout) {
+ return new Layers(layout, idRegister, this);
+ }
+
+ /**
+ * Registers the specified ID
+ * @param id ID content
+ * @return ID object
+ * @throws InvalidIdException ID invalid
+ */
+ public Id registerNewId(String id) throws InvalidIdException {
+ return idRegister.registerId(id);
+ }
+
+
+ //Extend class to get access to protected constructor.
+ private static class TextRegionItem extends TextRegion {
+ protected TextRegionItem(ContentFactory contentFactory, Id id, Polygon coords,
+ VariableMap attributes,
+ RegionContainer parentRegion) {
+ super(contentFactory, contentFactory.idRegister, id, coords, attributes, parentRegion);
+ }
+ }
+
+ //Extend class to get access to protected constructor.
+ private static class TextLineItem extends TextLine {
+ protected TextLineItem(ContentFactory contentFactory, Id id, Polygon coords, VariableMap attributes,
+ LowLevelTextContainer parentRegion) {
+ super(contentFactory, contentFactory.idRegister, id, coords, attributes, parentRegion);
+ }
+ }
+
+ //Extend class to get access to protected constructor.
+ private static class WordItem extends Word {
+ protected WordItem( ContentFactory contentFactory, Id id, Polygon coords,
+ VariableMap attributes,
+ LowLevelTextContainer parentRegion) {
+ super(contentFactory, contentFactory.idRegister, id, coords, attributes, parentRegion);
+ }
+ }
+
+ //Extend class to get access to protected constructor.
+ private static class GlyphItem extends Glyph {
+ protected GlyphItem(IdRegister idRegister, Id id, Polygon coords,
+ VariableMap attributes,
+ LowLevelTextContainer parentRegion) {
+ super(idRegister, id, coords, attributes, parentRegion);
+ }
+ }
+
+ //Extend class to get access to protected constructor.
+ private static class RegionItem extends RegionImpl {
+ protected RegionItem(IdRegister idRegister, RegionType type, Id id, Polygon coords, VariableMap attributes,
+ RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+ }
+
+ /**
+ * Sets the attribute factory that is used for creating attributes for new objects
+ */
+ public void setAttributeFactory(AttributeFactory factory) {
+ this.attributeFactory = factory;
+ }
+
+ /**
+ * Sets the ID register that is used for creating new objects
+ */
+ public IdRegister getIdRegister() {
+ return idRegister;
+ }
+
+
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentIterator.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentIterator.java
new file mode 100644
index 00000000..ea682b25
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentIterator.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical;
+
+import org.primaresearch.dla.page.layout.logical.Layer;
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+
+/**
+ * Iterator for all page content objects of a specified type
+ *
+ * @author Christian Clausner
+ *
+ */
+public interface ContentIterator {
+
+ /** Is there another page content object? */
+ public boolean hasNext();
+
+ /** Progresses the iterator and returns the next page content object. */
+ public ContentObject next();
+
+ /** Returns the content type of the page content objects this iterator was created for. */
+ public ContentType getContentType();
+
+ /** Returns the layer this iterator is restricted to (no null for no restriction) */
+ public Layer getLayer();
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentObject.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentObject.java
new file mode 100644
index 00000000..10937861
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentObject.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical;
+
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+import org.primaresearch.dla.page.layout.shared.GeometricObject;
+import org.primaresearch.ident.Identifiable;
+
+/**
+ * Represents physical page content objects (e.g. region, text line).
+ *
+ * @author Christian Clausner
+ *
+ */
+public interface ContentObject extends AttributeContainer, Identifiable, GeometricObject {
+
+ /**
+ * Suffix used for IDs of temporary content objects
+ */
+ public static final String TEMP_ID_SUFFIX = "357564684568544579089";
+
+ /**
+ * Returns the type of this page content object
+ */
+ public ContentType getType();
+
+ /**
+ * Checks if this is a temporary content object
+ * @return true if temporary, false if normal content object
+ */
+ public boolean isTemporary();
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentObjectProcessor.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentObjectProcessor.java
new file mode 100644
index 00000000..c7435e3f
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/ContentObjectProcessor.java
@@ -0,0 +1,129 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical;
+
+import org.primaresearch.dla.page.Page;
+import org.primaresearch.dla.page.layout.PageLayout;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextContainer;
+import org.primaresearch.dla.page.layout.physical.text.TextObject;
+
+/**
+ * Processes all content objects of a page using a customisable processing method.
+ *
+ * @author Christian Clausner
+ *
+ */
+public abstract class ContentObjectProcessor {
+
+ private ContentObject currentObject = null;
+
+ /** Flag to set if text lines, words, and glyphs should be included or not */
+ private boolean includeLowLevelTextObjects = true;
+
+ /**
+ * Called for each content object. Override with custom implementation.
+ */
+ public abstract void doProcess(ContentObject contentObject);
+
+ /**
+ * Called for each content object.
+ */
+ private void process(ContentObject contentObject) {
+ currentObject = contentObject;
+ doProcess(contentObject);
+ currentObject = null;
+ }
+
+ /**
+ * Returns the content object that is currently processed.
+ */
+ public ContentObject getCurrentObject() {
+ return currentObject;
+ }
+
+ /**
+ * Run the processor.
+ */
+ public void run(Page page) {
+
+ //Handle content objects
+ PageLayout layout = page.getLayout();
+ for (int r=0; rtrue if there are nested regions, false otherwise
+ */
+ public boolean hasRegions();
+
+ /**
+ * Returns the number of regions that are nested within this object
+ */
+ public int getRegionCount();
+
+ /**
+ * Returns a nested region
+ * @param index Position
+ * @return Region object
+ */
+ public Region getRegion(int index);
+
+ /**
+ * Adds a nested region
+ * @param region Region to add
+ */
+ public void addRegion(Region region);
+
+ /**
+ * Removes a nested region
+ * @param region Region to remove
+ */
+ public void removeRegion(Region region);
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/AdvertRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/AdvertRegion.java
new file mode 100644
index 00000000..d7caa4a5
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/AdvertRegion.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.DoubleValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for advert regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ */
+public class AdvertRegion extends RegionImpl {
+
+ public AdvertRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getBgColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_bgColour).getValue()).val;
+ }
+
+ public void setBgColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bgColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public double getOrientation() {
+ return ((DoubleValue)getAttributes().get(DefaultXmlNames.ATTR_orientation).getValue()).val;
+ }
+
+ public void setOrientation(double orientation) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_orientation).setValue(VariableValue.createValueObject(orientation));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ChartRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ChartRegion.java
new file mode 100644
index 00000000..43077523
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ChartRegion.java
@@ -0,0 +1,105 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.BooleanValue;
+import org.primaresearch.shared.variable.DoubleValue;
+import org.primaresearch.shared.variable.IntegerValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for chart regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ */
+public class ChartRegion extends RegionImpl {
+
+ public ChartRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getChartType() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_type).getValue()).val;
+ }
+
+ public void setChartType(String type) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_type).setValue(VariableValue.createValueObject(type));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public int getNumColours() {
+ return ((IntegerValue)getAttributes().get(DefaultXmlNames.ATTR_numColours).getValue()).val;
+ }
+
+ public void setNumColours(int num) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_numColours).setValue(VariableValue.createValueObject(num));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public String getBgColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_bgColour).getValue()).val;
+ }
+
+ public void setBgColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bgColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public double getOrientation() {
+ return ((DoubleValue)getAttributes().get(DefaultXmlNames.ATTR_orientation).getValue()).val;
+ }
+
+ public void setOrientation(double orientation) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_orientation).setValue(VariableValue.createValueObject(orientation));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public boolean hasEmbeddedText() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_embText).getValue()).val;
+ }
+
+ public void setEmbeddedText(boolean hasText) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_embText).setValue(VariableValue.createValueObject(hasText));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ChemRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ChemRegion.java
new file mode 100644
index 00000000..820b0fe5
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ChemRegion.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.DoubleValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for chemical formula regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ */
+public class ChemRegion extends RegionImpl {
+
+ public ChemRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getBgColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_bgColour).getValue()).val;
+ }
+
+ public void setBgColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bgColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public double getOrientation() {
+ return ((DoubleValue)getAttributes().get(DefaultXmlNames.ATTR_orientation).getValue()).val;
+ }
+
+ public void setOrientation(double orientation) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_orientation).setValue(VariableValue.createValueObject(orientation));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/FrameRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/FrameRegion.java
new file mode 100644
index 00000000..704cb61c
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/FrameRegion.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.BooleanValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for frame regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ */
+public class FrameRegion extends RegionImpl {
+
+ public FrameRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getBgColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_bgColour).getValue()).val;
+ }
+
+ public void setBgColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bgColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public boolean isBorderPresent() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_borderPresent).getValue()).val;
+ }
+
+ public void setBorderPresent(boolean border) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_borderPresent).setValue(VariableValue.createValueObject(border));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/GraphicRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/GraphicRegion.java
new file mode 100644
index 00000000..1517561e
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/GraphicRegion.java
@@ -0,0 +1,93 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.BooleanValue;
+import org.primaresearch.shared.variable.DoubleValue;
+import org.primaresearch.shared.variable.IntegerValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for graphic regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ */
+public class GraphicRegion extends RegionImpl {
+
+ public GraphicRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getGraphicType() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_type).getValue()).val;
+ }
+
+ public void setGraphicType(String type) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_type).setValue(VariableValue.createValueObject(type));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public int getNumColours() {
+ return ((IntegerValue)getAttributes().get(DefaultXmlNames.ATTR_numColours).getValue()).val;
+ }
+
+ public void setNumColours(int num) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_numColours).setValue(VariableValue.createValueObject(num));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public double getOrientation() {
+ return ((DoubleValue)getAttributes().get(DefaultXmlNames.ATTR_orientation).getValue()).val;
+ }
+
+ public void setOrientation(double orientation) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_orientation).setValue(VariableValue.createValueObject(orientation));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public boolean hasEmbeddedText() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_embText).getValue()).val;
+ }
+
+ public void setEmbeddedText(boolean hasText) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_embText).setValue(VariableValue.createValueObject(hasText));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ImageRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ImageRegion.java
new file mode 100644
index 00000000..b818c69b
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/ImageRegion.java
@@ -0,0 +1,93 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.BooleanValue;
+import org.primaresearch.shared.variable.DoubleValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for image regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class ImageRegion extends RegionImpl {
+
+ public ImageRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getColourDepth() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_colourDepth).getValue()).val;
+ }
+
+ public void setColourDepth(String colourDepth) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_colourDepth).setValue(VariableValue.createValueObject(colourDepth));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public String getBgColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_bgColour).getValue()).val;
+ }
+
+ public void setBgColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bgColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public double getOrientation() {
+ return ((DoubleValue)getAttributes().get(DefaultXmlNames.ATTR_orientation).getValue()).val;
+ }
+
+ public void setOrientation(double orientation) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_orientation).setValue(VariableValue.createValueObject(orientation));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public boolean hasEmbeddedText() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_embText).getValue()).val;
+ }
+
+ public void setEmbeddedText(boolean hasText) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_embText).setValue(VariableValue.createValueObject(hasText));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/LineDrawingRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/LineDrawingRegion.java
new file mode 100644
index 00000000..b2bfd563
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/LineDrawingRegion.java
@@ -0,0 +1,92 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.BooleanValue;
+import org.primaresearch.shared.variable.DoubleValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for line drawing regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ */
+public class LineDrawingRegion extends RegionImpl {
+
+ public LineDrawingRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getPenColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_penColour).getValue()).val;
+ }
+
+ public void setPenColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_penColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public String getBgColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_bgColour).getValue()).val;
+ }
+
+ public void setBgColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bgColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public double getOrientation() {
+ return ((DoubleValue)getAttributes().get(DefaultXmlNames.ATTR_orientation).getValue()).val;
+ }
+
+ public void setOrientation(double orientation) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_orientation).setValue(VariableValue.createValueObject(orientation));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public boolean hasEmbeddedText() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_embText).getValue()).val;
+ }
+
+ public void setEmbeddedText(boolean hasText) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_embText).setValue(VariableValue.createValueObject(hasText));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/LowLevelTextObjectIterator.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/LowLevelTextObjectIterator.java
new file mode 100644
index 00000000..03f1aa70
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/LowLevelTextObjectIterator.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.layout.PageLayout;
+import org.primaresearch.dla.page.layout.logical.Layer;
+import org.primaresearch.dla.page.layout.physical.ContentIterator;
+import org.primaresearch.dla.page.layout.physical.ContentObject;
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+import org.primaresearch.dla.page.layout.physical.shared.LowLevelTextType;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextContainer;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextObject;
+
+/**
+ * Page content object iterator implementation for low level text objects (text lines, words, and glyphs).
+ *
+ * @author Christian Clausner
+ *
+ */
+public class LowLevelTextObjectIterator implements ContentIterator {
+
+ private LowLevelTextType contentType;
+ private Layer layer;
+ private int index = 0;
+ private ContentIterator parentIterator;
+ private LowLevelTextContainer parent = null;
+
+ /**
+ * Constructor
+ * @param contentType Low level text object type (text line, word, or glyph)
+ * @param layer Restrict the iterator to this layer (use null for no restriction)
+ */
+ public LowLevelTextObjectIterator(PageLayout pageLayout, LowLevelTextType contentType, Layer layer) {
+ this.contentType = contentType;
+ this.layer = layer;
+
+ if (contentType.equals(LowLevelTextType.TextLine))
+ parentIterator = new RegionIterator(pageLayout, RegionType.TextRegion, layer);
+ else if (contentType.equals(LowLevelTextType.Word))
+ parentIterator = new LowLevelTextObjectIterator(pageLayout, LowLevelTextType.TextLine, layer);
+ else if (contentType.equals(LowLevelTextType.Glyph))
+ parentIterator = new LowLevelTextObjectIterator(pageLayout, LowLevelTextType.Word, layer);
+
+ parent = (LowLevelTextContainer)parentIterator.next();
+ }
+
+ @Override
+ public boolean hasNext() {
+ while (parent != null) {
+ if (index < parent.getTextObjectCount())
+ return true;
+ parent = (LowLevelTextContainer)parentIterator.next();
+ index = 0;
+ }
+ return false;
+ }
+
+ @Override
+ public ContentObject next() {
+ if (!hasNext())
+ return null;
+ LowLevelTextObject ret = parent.getTextObject(index);
+ index++;
+ return ret;
+ }
+
+ @Override
+ public ContentType getContentType() {
+ return contentType;
+ }
+
+ @Override
+ public Layer getLayer() {
+ return layer;
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/MathsRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/MathsRegion.java
new file mode 100644
index 00000000..79f6bcbf
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/MathsRegion.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.DoubleValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for maths regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ */
+public class MathsRegion extends RegionImpl {
+
+ public MathsRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getBgColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_bgColour).getValue()).val;
+ }
+
+ public void setBgColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bgColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public double getOrientation() {
+ return ((DoubleValue)getAttributes().get(DefaultXmlNames.ATTR_orientation).getValue()).val;
+ }
+
+ public void setOrientation(double orientation) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_orientation).setValue(VariableValue.createValueObject(orientation));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/MusicRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/MusicRegion.java
new file mode 100644
index 00000000..a1ffb1ba
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/MusicRegion.java
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.DoubleValue;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised implementation for musical notation regions.
+ * Provides getters and setters for default attributes.
+ *
+ * @author Christian Clausner
+ */
+public class MusicRegion extends RegionImpl {
+
+ public MusicRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+ public String getBgColour() {
+ return ((StringValue)getAttributes().get(DefaultXmlNames.ATTR_bgColour).getValue()).val;
+ }
+
+ public void setBgColour(String colour) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bgColour).setValue(VariableValue.createValueObject(colour));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ public double getOrientation() {
+ return ((DoubleValue)getAttributes().get(DefaultXmlNames.ATTR_orientation).getValue()).val;
+ }
+
+ public void setOrientation(double orientation) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_orientation).setValue(VariableValue.createValueObject(orientation));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/NoiseRegion.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/NoiseRegion.java
new file mode 100644
index 00000000..80075367
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/NoiseRegion.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.VariableMap;
+
+/**
+ * Specialised implementation for noise regions.
+ *
+ * @author Christian Clausner
+ */
+public class NoiseRegion extends RegionImpl {
+
+ public NoiseRegion(IdRegister idRegister, RegionType type, Id id,
+ Polygon coords, VariableMap attributes, RegionContainer parentRegion) {
+ super(idRegister, type, id, coords, attributes, parentRegion);
+ }
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/RegionImpl.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/RegionImpl.java
new file mode 100644
index 00000000..59be332c
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/impl/RegionImpl.java
@@ -0,0 +1,145 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.impl;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.primaresearch.dla.page.layout.physical.Region;
+import org.primaresearch.dla.page.layout.physical.RegionContainer;
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+import org.primaresearch.dla.page.layout.physical.shared.RegionType;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.ident.IdRegister.InvalidIdException;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.VariableMap;
+
+/**
+ * Basic implementation for layout regions.
+ *
+ * @author Christian Clausner
+ *
+ */
+public abstract class RegionImpl implements Region {
+
+ private RegionType type;
+ private Id id;
+ private IdRegister idRegister;
+
+ private Polygon coords;
+
+ private VariableMap attributes;
+
+ private RegionContainer parentRegion;
+
+ private Listnull to include all regions
+ * @param layer Restrict the iterator to this layer (use null for no restriction)
+ */
+ public RegionIterator(PageLayout pageLayout, RegionType contentType, Layer layer) {
+ this.contentType = contentType;
+ this.pageLayout = pageLayout;
+ this.layer = layer;
+ }
+
+
+ @Override
+ public boolean hasNext() {
+ if (contentType == null && layer == null) { //No specific region type or layer
+ if (currentNestedRegionIterator == null)
+ return index < pageLayout.getRegionCount();
+ else
+ return currentNestedRegionIterator.hasNext() || index < pageLayout.getRegionCount()-1;
+ }
+ //Filter by region type and/or layer
+ else {
+ boolean ok;
+ int startIndex = index;
+
+ //Check current nested iterator first
+ if (currentNestedRegionIterator != null) {
+ if (currentNestedRegionIterator.hasNext())
+ return true;
+ else
+ startIndex++;
+ }
+
+ //Go through all remaining regions
+ for (int i=startIndex; ifalse if empty
+ */
+ public boolean hasTextObjects();
+
+ /**
+ * Returns the number of child text objects
+ */
+ public int getTextObjectCount();
+
+ /**
+ * Returns a child text object
+ * @param index Position
+ * @return Child text object
+ * @throws IndexOutOfBoundsException Invalid index
+ */
+ public LowLevelTextObject getTextObject(int index) throws IndexOutOfBoundsException;
+
+ /**
+ * Returns a child text object
+ * @param id ID of child
+ * @return Child text object
+ */
+ public LowLevelTextObject getTextObject(Id id);
+
+ /**
+ * Adds a child text object
+ * @param textObj Object to add
+ */
+ public void addTextObject(LowLevelTextObject textObj);
+
+ /**
+ * Removes a child text object
+ * @param index Position
+ * @throws IndexOutOfBoundsException Invalid index
+ */
+ public void removeTextObject(int index) throws IndexOutOfBoundsException;
+
+ /**
+ * Removes a child text object
+ * @param id ID of child
+ */
+ public void removeTextObject(Id id);
+
+ /**
+ * Returns a sorted list of all text objects (sorts by x or y position, depending on the object type).
+ */
+ public Listtrue the text content of this object will be replaced by the composed text (only if the composed text is not empty)
+ * @param recursive If set to true all lower levels of text objects are used for the composition
+ * @return Composed text
+ */
+ public String composeText(boolean replaceTextContent, boolean recursive);
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainerImpl.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainerImpl.java
new file mode 100644
index 00000000..3d9a48eb
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/LowLevelTextContainerImpl.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.text;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.primaresearch.collections.IndexedMap;
+import org.primaresearch.collections.IndexedMapImpl;
+import org.primaresearch.dla.page.layout.GeometricObjectPositionComparator;
+import org.primaresearch.ident.Id;
+
+/**
+ * Basic implementation of a low level text object container.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class LowLevelTextContainerImpl {
+
+ private IndexedMaptrue for bold text, false for normal text, or null if not set.
+ */
+ public Boolean isBold();
+
+ /**
+ * Bold text?
+ * @param bold true for bold text, false for normal text, or null for 'not set'.
+ */
+ public void setBold(Boolean bold);
+
+ /**
+ * Italic text?
+ * @return true for italic text, false for normal text, or null if not set.
+ */
+ public Boolean isItalic();
+
+ /**
+ * Italic text?
+ * @param italic true for italic text, false for normal text, or null for 'not set'.
+ */
+ public void setItalic(Boolean italic);
+
+ /**
+ * Underlined text?
+ * @return true for underlined text, false for not underlined text, or null if not set.
+ */
+ public Boolean isUnderlined();
+
+ /**
+ * Underlined text?
+ * @param underlined true for underlined text, false for not underlined text, or null if not set.
+ */
+ public void setUnderlined(Boolean underlined);
+
+ /**
+ * Subscript (small letters below the baseline)?
+ * @return true for subscript, false for normal text, or null if not set.
+ */
+ public Boolean isSubscript();
+
+ /**
+ * Subscript (small letters below the baseline)?
+ * @param subscript true for subscript, false for normal text, or null if not set.
+ */
+ public void setSubscript(Boolean subscript);
+
+ /**
+ * Superscript (small letters above the line of text)?
+ * @return true for superscript, false for normal text, or null if not set.
+ */
+ public Boolean isSuperscript();
+
+ /**
+ * Superscript (small letters above the line of text)?
+ * @param superscript true for superscript, false for normal text, or null if not set.
+ */
+ public void setSuperscript(Boolean superscript);
+
+ /**
+ * Strikethrough (line through text)?
+ * @return true for strikethrough, false for normal text, or null if not set.
+ */
+ public Boolean isStrikethrough();
+
+ /**
+ * Strikethrough (line through text)?
+ * @param strikethrough true for strikethrough, false for normal text, or null if not set.
+ */
+ public void setStrikethrough(Boolean strikethrough);
+
+ /**
+ * Small caps (lower case characters appear as smaller capitals)?
+ * @return true for small caps, false for normal text, or null if not set.
+ */
+ public Boolean isSmallCaps();
+
+ /**
+ * Small caps (lower case characters appear as smaller capitals)?
+ * @param smallCaps true for small caps, false for normal text, or null if not set.
+ */
+ public void setSmallCaps(Boolean smallCaps);
+
+ /**
+ * Letter spaced (gaps between characters)?
+ * @return true for letter spaced text, false for normal text, or null if not set.
+ */
+ public Boolean isLetterSpaced();
+
+ /**
+ * Letter spaced (gaps between characters)?
+ * @param letterSpaced true for letter spaced text, false for normal text, or null if not set.
+ */
+ public void setLetterSpaced(Boolean letterSpaced);
+
+
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/DefaultTextRegionTypes.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/DefaultTextRegionTypes.java
new file mode 100644
index 00000000..7a052801
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/DefaultTextRegionTypes.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.text.impl;
+
+/**
+ * Collection of text region sub-types in compliance with the PAGE XML schema (version 2013-07-15).
+ *
+ * @author Christian Clausner
+ *
+ */
+public interface DefaultTextRegionTypes {
+ public static final String PARAGRAPH = "paragraph";
+ public static final String HEADING = "heading";
+ public static final String CAPTION = "caption";
+ public static final String HEADER = "header";
+ public static final String FOOTER = "footer";
+ public static final String PAGE_NUMBER = "page-number";
+ public static final String DROP_CAPITAL = "drop-capital";
+ public static final String CREDIT = "credit";
+ public static final String FLOATING = "floating";
+ public static final String SIGNATURE_MARK = "signature-mark";
+ public static final String CATCH_WORD = "catch-word";
+ public static final String MARGINALIA = "marginalia";
+ public static final String FOOTNOTE = "footnote";
+ public static final String FOOTNOTE_CONTINUED = "footnote-continued";
+ public static final String TOC_ENTRY = "TOC-entry";
+ public static final String ENDNOTE = "endnote";
+ public static final String OTHER = "other";
+}
\ No newline at end of file
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/Glyph.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/Glyph.java
new file mode 100644
index 00000000..9c81a271
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/Glyph.java
@@ -0,0 +1,156 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.text.impl;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+import org.primaresearch.dla.page.layout.physical.shared.LowLevelTextType;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextContainer;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextObject;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.BooleanValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+
+/**
+ * Specialised low level text object representing glyphs within a page layout.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class Glyph extends LowLevelTextObject {
+
+ protected Glyph(IdRegister idRegister, Id id, Polygon coords, VariableMap attributes,
+ LowLevelTextContainer parentWord) {
+ super(idRegister, id, coords, attributes, parentWord);
+ }
+
+ @Override
+ public ContentType getType() {
+ return LowLevelTextType.Glyph;
+ }
+
+ @Override
+ public Boolean isBold() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_bold).getValue()).val;
+ }
+
+ @Override
+ public void setBold(Boolean bold) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_bold).setValue(VariableValue.createValueObject(bold));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ public Boolean isItalic() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_bold).getValue()).val;
+ }
+
+ @Override
+ public void setItalic(Boolean italic) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_italic).setValue(VariableValue.createValueObject(italic));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ public Boolean isUnderlined() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_italic).getValue()).val;
+ }
+
+ @Override
+ public void setUnderlined(Boolean underlined) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_underlined).setValue(VariableValue.createValueObject(underlined));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ public Boolean isSubscript() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_underlined).getValue()).val;
+ }
+
+ @Override
+ public void setSubscript(Boolean subscript) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_subscript).setValue(VariableValue.createValueObject(subscript));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ public Boolean isSuperscript() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_subscript).getValue()).val;
+ }
+
+ @Override
+ public void setSuperscript(Boolean superscript) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_superscript).setValue(VariableValue.createValueObject(superscript));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ public Boolean isStrikethrough() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_superscript).getValue()).val;
+ }
+
+ @Override
+ public void setStrikethrough(Boolean strikethrough) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_strikethrough).setValue(VariableValue.createValueObject(strikethrough));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ public Boolean isSmallCaps() {
+ return ((BooleanValue)getAttributes().get(DefaultXmlNames.ATTR_smallCaps).getValue()).val;
+ }
+
+ @Override
+ public void setSmallCaps(Boolean smallCaps) {
+ try {
+ getAttributes().get(DefaultXmlNames.ATTR_smallCaps).setValue(VariableValue.createValueObject(smallCaps));
+ } catch (WrongVariableTypeException e) {
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ public Boolean isLetterSpaced() {
+ return false;
+ }
+
+ @Override
+ public void setLetterSpaced(Boolean letterSpaced) {
+ //Glyph cannot be letter spaced
+ }
+}
diff --git a/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/TextLine.java b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/TextLine.java
new file mode 100644
index 00000000..c2aa4684
--- /dev/null
+++ b/java/PrimaDla/src/org/primaresearch/dla/page/layout/physical/text/impl/TextLine.java
@@ -0,0 +1,282 @@
+/*
+ * Copyright 2014 PRImA Research Lab, University of Salford, United Kingdom
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.primaresearch.dla.page.layout.physical.text.impl;
+
+import java.util.List;
+
+import org.primaresearch.dla.page.io.xml.DefaultXmlNames;
+import org.primaresearch.dla.page.layout.physical.ContentFactory;
+import org.primaresearch.dla.page.layout.physical.shared.ContentType;
+import org.primaresearch.dla.page.layout.physical.shared.LowLevelTextType;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextContainer;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextContainerImpl;
+import org.primaresearch.dla.page.layout.physical.text.LowLevelTextObject;
+import org.primaresearch.ident.Id;
+import org.primaresearch.ident.IdRegister;
+import org.primaresearch.ident.IdRegister.InvalidIdException;
+import org.primaresearch.maths.geometry.Polygon;
+import org.primaresearch.shared.variable.BooleanValue;
+import org.primaresearch.shared.variable.Variable.WrongVariableTypeException;
+import org.primaresearch.shared.variable.StringValue;
+import org.primaresearch.shared.variable.VariableMap;
+import org.primaresearch.shared.variable.VariableValue;
+
+/**
+ * Specialised low level text object representing text lines within a page layout.
+ *
+ * @author Christian Clausner
+ *
+ */
+public class TextLine extends LowLevelTextObject
+ implements LowLevelTextContainer {
+
+ private LowLevelTextContainerImpl words = new LowLevelTextContainerImpl();
+
+ private Polygon baseline;
+
+ private ContentFactory contentFactory;
+
+
+ protected TextLine(ContentFactory contentFactory, IdRegister idRegister, Id id, Polygon coords,
+ VariableMap attributes, //VariableMap textStyle,
+ LowLevelTextContainer parentRegion) {
+ super(idRegister, id, coords, attributes, parentRegion);
+ this.contentFactory = contentFactory;
+ }
+
+ @Override
+ public boolean hasTextObjects() {
+ return words.hasTextObjects();
+ }
+
+ @Override
+ public int getTextObjectCount() {
+ return words.getTextObjectCount();
+ }
+
+ @Override
+ public LowLevelTextObject getTextObject(int index) {
+ return words.getTextObject(index);
+ }
+
+ public Word createWord() {
+ return createWord(null);
+ }
+
+ /**
+ * Creates a new word object and adds it to this text line.
+ * @param id Preferred ID for the word (not guaranteed, check the result word for the actual ID)
+ * @return The new word
+ */
+ public Word createWord(String id) {
+ Word word = (Word)contentFactory.createContent(LowLevelTextType.Word);
+ word.setParent(this);
+ if (id != null) {
+ try {
+ word.setId(id);
+ } catch (InvalidIdException e) {
+ e.printStackTrace();
+ }
+ }
+ addTextObject(word);
+ return word;
+ }
+
+ @Override
+ public void addTextObject(LowLevelTextObject textObj) {
+ words.addTextObject(textObj);
+ }
+
+ @Override
+ public ContentType getType() {
+ return LowLevelTextType.TextLine;
+ }
+
+ @Override
+ public LowLevelTextObject getTextObject(Id id) {
+ return words.getTextObject(id);
+ }
+
+ @Override
+ public void removeTextObject(int index) throws IndexOutOfBoundsException {
+ words.removeTextObject(index);
+ }
+
+ @Override
+ public void removeTextObject(Id id) {
+ words.removeTextObject(id);
+ }
+
+ @Override
+ public List