123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289 |
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You 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.
- */
-
- /* $Id$ */
-
- package org.apache.fop.afp;
-
- import org.apache.commons.logging.Log;
- import org.apache.commons.logging.LogFactory;
-
- import org.apache.fop.afp.modca.Registry;
- import org.apache.fop.afp.modca.triplets.MappingOptionTriplet;
-
- /**
- * A list of parameters associated with an AFP data objects
- */
- public class AFPDataObjectInfo {
- private static final Log log = LogFactory.getLog("org.apache.xmlgraphics.afp");
-
- /** the object area info */
- private AFPObjectAreaInfo objectAreaInfo;
-
- /** resource info */
- private AFPResourceInfo resourceInfo;
-
- /** the data object width */
- private int dataWidth;
-
- /** the data object height */
- private int dataHeight;
-
- /** the object registry mimetype */
- private String mimeType;
-
- /** the object data in a byte array */
- private byte[] data;
-
- /** the object data height resolution */
- private int dataHeightRes;
-
- /** the object data width resolution */
- private int dataWidthRes;
-
- /** controls whether to create a page segment or a simple object */
- private boolean createPageSegment;
-
- /** controls the mapping of the image data into the image area */
- private byte mappingOption = MappingOptionTriplet.SCALE_TO_FILL;
-
- /**
- * Default constructor
- */
- public AFPDataObjectInfo() {
- }
-
- /**
- * Sets the image mime type
- *
- * @param mimeType the image mime type
- */
- public void setMimeType(String mimeType) {
- this.mimeType = mimeType;
- }
-
- /**
- * Returns the mime type of this data object
- *
- * @return the mime type of this data object
- */
- public String getMimeType() {
- return mimeType;
- }
-
- /**
- * Convenience method to return the object type
- *
- * @return the object type
- */
- public Registry.ObjectType getObjectType() {
- return Registry.getInstance().getObjectType(getMimeType());
- }
-
- /**
- * Returns the resource level at which this data object should reside
- *
- * @return the resource level at which this data object should reside
- */
- public AFPResourceInfo getResourceInfo() {
- if (resourceInfo == null) {
- this.resourceInfo = new AFPResourceInfo();
- }
- return resourceInfo;
- }
-
- /**
- * Sets the resource level at which this object should reside
- *
- * @param resourceInfo the resource level at which this data object should reside
- */
- public void setResourceInfo(AFPResourceInfo resourceInfo) {
- this.resourceInfo = resourceInfo;
- }
-
- /**
- * Sets the object area info
- *
- * @param objectAreaInfo the object area info
- */
- public void setObjectAreaInfo(AFPObjectAreaInfo objectAreaInfo) {
- this.objectAreaInfo = objectAreaInfo;
- }
-
- /**
- * Returns the object area info
- *
- * @return the object area info
- */
- public AFPObjectAreaInfo getObjectAreaInfo() {
- return this.objectAreaInfo;
- }
-
- /**
- * Returns the uri of this data object
- *
- * @return the uri of this data object
- */
- public String getUri() {
- return getResourceInfo().getUri();
- }
-
- /**
- * Sets the data object uri
- *
- * @param uri the data object uri
- */
- public void setUri(String uri) {
- getResourceInfo().setUri(uri);
- }
-
- /**
- * Returns the image data width
- *
- * @return the image data width
- */
- public int getDataWidth() {
- return dataWidth;
- }
-
- /**
- * Sets the image data width
- *
- * @param imageDataWidth the image data width
- */
- public void setDataWidth(int imageDataWidth) {
- this.dataWidth = imageDataWidth;
- }
-
- /**
- * Returns the image data height
- *
- * @return the image data height
- */
- public int getDataHeight() {
- return dataHeight;
- }
-
- /**
- * Sets the image data height
- *
- * @param imageDataHeight the image data height
- */
- public void setDataHeight(int imageDataHeight) {
- this.dataHeight = imageDataHeight;
- }
-
- /**
- * Returns the data height resolution
- *
- * @return the data height resolution
- */
- public int getDataHeightRes() {
- return this.dataHeightRes;
- }
-
- /**
- * Sets the data width resolution
- *
- * @param dataWidthRes the data width resolution
- */
- public void setDataHeightRes(int dataHeightRes) {
- this.dataHeightRes = dataHeightRes;
- }
-
- /**
- * Returns the data width resolution
- *
- * @return the data width resolution
- */
- public int getDataWidthRes() {
- return this.dataWidthRes;
- }
-
- /**
- * Sets the data width resolution
- *
- * @param dataWidthRes the data width resolution
- */
- public void setDataWidthRes(int dataWidthRes) {
- this.dataWidthRes = dataWidthRes;
- }
-
- /**
- * Sets the object data
- *
- * @param data the object data
- */
- public void setData(byte[] data) {
- this.data = data;
- }
-
- /**
- * Returns the object data
- *
- * @return the object data
- */
- public byte[] getData() {
- return this.data;
- }
-
- /**
- * Controls whether to create a page segment or a normal object.
- * @param value true for page segments, false for objects
- */
- public void setCreatePageSegment(boolean value) {
- this.createPageSegment = value;
- }
-
- /**
- * Indicates whether a page segment or a normal object shall be created.
- * @return true for page segments, false for objects
- */
- public boolean isCreatePageSegment() {
- return this.createPageSegment;
- }
-
- /**
- * Sets the way an image is mapped into its target area.
- * @param mappingOption the mapping option (Valid values: see Mapping Option Triplet)
- */
- public void setMappingOption(byte mappingOption) {
- this.mappingOption = mappingOption;
- }
-
- /**
- * Returns the way an image is mapped into its target area. By default, this is "scale to fill"
- * behavior.
- * @return the mapping option value from the Mapping Option Triplet
- */
- public byte getMappingOption() {
- return mappingOption;
- }
-
- /** {@inheritDoc} */
- public String toString() {
- return "AFPDataObjectInfo{"
- + "mimeType=" + mimeType
- + ", dataWidth=" + dataWidth
- + ", dataHeight=" + dataHeight
- + ", dataWidthRes=" + dataWidthRes
- + ", dataHeightRes=" + dataHeightRes
- + (objectAreaInfo != null ? ", objectAreaInfo=" + objectAreaInfo : "")
- + (resourceInfo != null ? ", resourceInfo=" + resourceInfo : "");
- }
-
- }
|