Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Braille Utils (C) 2010-2011 Daisy Consortium
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.daisy.braille.utils.pef;
import org.xml.sax.SAXException;
import java.io.IOException;
import java.io.Serializable;
import java.net.URI;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.xpath.XPathExpressionException;
/**
* Provides useful information about a PEF-document.
*
* @author Joel Håkansson
*/
public class PEFBook implements Serializable {
private static final long serialVersionUID = -4374354333984669371L;
private static final String VALUE_OUT_OF_RANGE = "Value out of range: {0}";
private final Map> metadata;
// Book properties
private final URI uri;
private final int volumes;
private final int pageTags;
private final int pages;
private final int maxWidth;
private final int maxHeight;
private final String inputEncoding;
private final boolean containsEightDot;
private final Map startPages;
private final int[] sectionsInVolume;
PEFBook(
URI uri,
Map> metadata,
int volumes,
int pages,
int pageTags,
int maxWidth,
int maxHeight,
String inputEncoding,
boolean containsEightDot,
int[] startPages
) {
this(
uri,
metadata,
volumes,
pages,
pageTags,
maxWidth,
maxHeight,
inputEncoding,
containsEightDot,
getLocations(startPages),
generateSections(volumes)
);
}
PEFBook(
URI uri,
Map> metadata,
int volumes,
int pages,
int pageTags,
int maxWidth,
int maxHeight,
String inputEncoding,
boolean containsEightDot,
Map startPages,
int[] sectionsInVolume
) {
this.uri = uri;
this.metadata = metadata;
this.volumes = volumes;
this.pages = pages;
this.pageTags = pageTags;
this.maxWidth = maxWidth;
this.maxHeight = maxHeight;
this.inputEncoding = inputEncoding;
this.containsEightDot = containsEightDot;
this.startPages = Collections.unmodifiableMap(new HashMap<>(startPages));
this.sectionsInVolume = sectionsInVolume;
}
/**
* Loads information about a PEF-document from the supplied URI.
*
* @param uri the URI to a PEF-document
*
* @return returns a PEFBook object containing the information collected from the supplied PEF-document,
* or null if an error occurred
*
* @throws ParserConfigurationException never thrown
* @throws SAXException never thrown
* @throws XPathExpressionException never thrown
* @throws IOException never thrown
*/
public static PEFBook load(
URI uri
) throws ParserConfigurationException, SAXException, XPathExpressionException, IOException {
//TODO: the above exceptions are not actually thrown from this method. Note that removing the would
// require a new major version.
return StaxPEFBook.loadStax(uri);
}
private static Map getLocations(int[] startPages) {
Map locations = new HashMap<>();
for (int i = 0; i < startPages.length; i++) {
locations.put(new SectionIdentifier(i + 1), startPages[i]);
}
return locations;
}
private static int[] generateSections(int volumes) {
int[] ret = new int[volumes];
Arrays.fill(ret, 1);
return ret;
}
/**
* Gets the encoding used for this document at the time of the parsing.
*
* @return returns the input encoding
*/
public String getInputEncoding() {
return inputEncoding;
}
/**
* Gets the uri for the document at the time of parsing.
*
* @return returns the uri
*/
public URI getURI() {
return uri;
}
/**
* Gets the number of volumes in this document.
*
* @return returns the number of volumes
*/
public int getVolumes() {
return volumes;
}
/**
* Gets the number of sections in the specified volume.
*
* @param volume the volume number, one based
* @return returns the number of sections
* @throws IllegalArgumentException if the volume is less than 1 or greater than {@link #getVolumes()}
*/
public int getSectionsInVolume(int volume) {
if (volume < 1 || volume > getVolumes()) {
throw new IllegalArgumentException(MessageFormat.format(VALUE_OUT_OF_RANGE, volume));
}
return sectionsInVolume[volume - 1];
}
/**
* Gets the total number of pages in this document.
*
* @return returns the number of pages
*/
public int getPages() {
return pages;
}
/**
* Gets the number of page tags in this document.
*
* @return returns the number of page tags
*/
public int getPageTags() {
return pageTags;
}
/**
* Gets the number of sheets in this document.
*
* @return returns the number of sheets
*/
public int getSheets() {
return (pages + 1) / 2;
}
/**
* Gets the number of sheets in the specified volume.
*
* @param volume the volume number, one based
* @return returns the number of sheets in the specified volume
* @throws IllegalArgumentException if the volume is less than 1 or greater than
* {@link #getVolumes()}
*/
public int getSheets(int volume) {
if (volume < 1 || volume > getVolumes()) {
throw new IllegalArgumentException(MessageFormat.format(VALUE_OUT_OF_RANGE, volume));
}
return ((getLastPage(volume) - (getFirstPage(volume) - 1)) + 1) / 2;
}
/**
* Gets the number of sheets in the specified section.
*
* @param volume the volume number, one based
* @param section the section number, one based
* @return returns the number of sheets in the specified section
* @throws IllegalArgumentException if the volume is less than 1 or greater than
* {@link #getVolumes()} or if section is less than 1 or greater than
* {@link #getSectionsInVolume(int)}
*/
public int getSheets(int volume, int section) {
if (volume < 1 || volume > getVolumes()) {
throw new IllegalArgumentException(MessageFormat.format(VALUE_OUT_OF_RANGE, volume));
}
return ((getLastPage(volume, section) - (getFirstPage(volume, section) - 1)) + 1) / 2;
}
/**
* Gets the first page number in the specified volume.
*
* @param volume the volume number, one based
* @return returns the first page number in the specified volume
* @throws IllegalArgumentException if the volume is less than 1 or greater than
* {@link #getVolumes()}
*/
public int getFirstPage(int volume) {
return getFirstPage(volume, 1);
}
/**
* Gets the first page number in the specified section.
*
* @param volume the volume number, one based
* @param section the section number, one based
* @return returns the first page number in the specified section
* @throws IllegalArgumentException if the volume is less than 1 or greater than
* {@link #getVolumes()} or if section is less than 1 or greater than
* {@link #getSectionsInVolume(int)}
*/
public int getFirstPage(int volume, int section) {
if (volume < 1 || volume > getVolumes()) {
throw new IllegalArgumentException(MessageFormat.format(VALUE_OUT_OF_RANGE, volume));
}
if (section < 1 || section > getSectionsInVolume(volume)) {
throw new IllegalArgumentException(MessageFormat.format(VALUE_OUT_OF_RANGE, section));
}
return startPages.get(new SectionIdentifier(volume, section));
}
/**
* Gets the last page number in the specified volume.
*
* @param volume the volume number, one based
* @return returns the last page number in the specified volume
* @throws IllegalArgumentException if the volume is less than 1 or greater than
* {@link #getVolumes()}
*/
public int getLastPage(int volume) {
return getLastPage(volume, getSectionsInVolume(volume));
}
/**
* Gets the last page number in the specified section.
*
* @param volume the volume number, one based
* @param section the section number, one based
* @return returns the last page number in the specified section
* @throws IllegalArgumentException if the volume is less than 1 or greater than
* {@link #getVolumes()} or if section is less than 1 or greater than
* {@link #getSectionsInVolume(int)}
*/
public int getLastPage(int volume, int section) {
if (volume < 1 || volume > getVolumes()) {
throw new IllegalArgumentException("Value out of range: " + volume);
}
int sectionsInSpecifiedVolume = getSectionsInVolume(volume);
if (section < 1 || section > sectionsInSpecifiedVolume) {
throw new IllegalArgumentException("Value out of range: " + section);
}
if (volume == getVolumes() && section == sectionsInSpecifiedVolume) {
return getPages();
} else {
if (section < sectionsInSpecifiedVolume) {
return startPages.get(new SectionIdentifier(volume, section + 1)) - 1;
} else {
return startPages.get(new SectionIdentifier(volume + 1)) - 1;
}
}
}
/**
* Gets the maximum defined page width, in chars.
*
* @return returns the maximum page width
*/
public int getMaxWidth() {
return maxWidth;
}
/**
* Gets the maximum defined page height, in rows.
*
* @return returns the maximum page height
*/
public int getMaxHeight() {
return maxHeight;
}
/**
* Returns true if this document contains eight dot patterns, false otherwise.
*
* @return returns true if the document contains eight dot patterns, false otherwise
*/
public boolean containsEightDot() {
return containsEightDot;
}
/**
* Gets a collection of all metadata keys in this document.
* A metadata key is a local element name in the http://purl.org/dc/elements/1.1/ namespace.
*
* @return returns the metadata keys
*/
public Iterable getMetadataKeys() {
return metadata.keySet();
}
/**
* Gets a collection of values for a specfied metadata key.
* A metadata key is a local element name in the http://purl.org/dc/elements/1.1/ namespace.
*
* @param key the metadata to get values for
* @return returns the values for the specified key
*/
public Iterable getMetadata(String key) {
List c = metadata.get(key);
if (c != null) {
return c;
}
return Collections.emptyList();
}
/**
* Gets the document titles from this document's metadata. Convenience method for
* getMetadata("title").
*
* @return returns the document titles
*/
public Iterable getTitle() {
return getMetadata("title");
}
/**
* Gets the document authors from this document's metadata. Convenience method for
* getMetadata("creator").
*
* @return returns the document authors
*/
public Iterable getAuthors() {
return getMetadata("creator");
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + (containsEightDot ? 1231 : 1237);
result = prime * result + ((inputEncoding == null) ? 0 : inputEncoding.hashCode());
result = prime * result + maxHeight;
result = prime * result + maxWidth;
result = prime * result + ((metadata == null) ? 0 : metadata.hashCode());
result = prime * result + pageTags;
result = prime * result + pages;
result = prime * result + Arrays.hashCode(sectionsInVolume);
result = prime * result + ((startPages == null) ? 0 : startPages.hashCode());
result = prime * result + ((uri == null) ? 0 : uri.hashCode());
result = prime * result + volumes;
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
PEFBook other = (PEFBook) obj;
if (containsEightDot != other.containsEightDot) {
return false;
}
if (inputEncoding == null) {
if (other.inputEncoding != null) {
return false;
}
} else if (!inputEncoding.equals(other.inputEncoding)) {
return false;
}
if (maxHeight != other.maxHeight) {
return false;
}
if (maxWidth != other.maxWidth) {
return false;
}
if (metadata == null) {
if (other.metadata != null) {
return false;
}
} else if (!metadata.equals(other.metadata)) {
return false;
}
if (pageTags != other.pageTags) {
return false;
}
if (pages != other.pages) {
return false;
}
if (!Arrays.equals(sectionsInVolume, other.sectionsInVolume)) {
return false;
}
if (startPages == null) {
if (other.startPages != null) {
return false;
}
} else if (!startPages.equals(other.startPages)) {
return false;
}
if (uri == null) {
if (other.uri != null) {
return false;
}
} else if (!uri.equals(other.uri)) {
return false;
}
if (volumes != other.volumes) {
return false;
}
return true;
}
@Override
public String toString() {
return "PEFBook [metadata=" + metadata + ", uri=" + uri + ", volumes=" + volumes + ", pageTags=" + pageTags
+ ", pages=" + pages + ", maxWidth=" + maxWidth + ", maxHeight=" + maxHeight + ", inputEncoding="
+ inputEncoding + ", containsEightDot=" + containsEightDot + ", startPages=" + startPages
+ ", sectionsInVolume=" + Arrays.toString(sectionsInVolume) + "]";
}
}
