aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/render/afp/DataObjectInfo.java
blob: b25470551ad656af0def044666b2a8774f87fab7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
 * 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.render.afp;

import java.io.File;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.fop.render.afp.extensions.AFPElementMapping;
import org.apache.fop.render.afp.modca.Registry;
import org.apache.fop.render.afp.modca.Registry.ObjectType;
import org.apache.xmlgraphics.util.QName;

/**
 * A list of parameters associated with an AFP data objects
 */
public class DataObjectInfo {
    private static final Log log = LogFactory.getLog("org.apache.fop.afp");

    private static final String RESOURCE_NAME = "afp:resource-name";
    private static final String RESOURCE_LEVEL = "afp:resource-level";
    private static final String RESOURCE_GROUP_FILE = "afp:resource-group-file";

    private static final ResourceInfo DEFAULT_RESOURCE_INFO = new ResourceInfo();
    
    private String uri;
    
    /** the object area info */
    private ObjectAreaInfo objectAreaInfo;    
    
    /** object type entry */
    private ObjectType objectType;
    
    /** resource info */
    private ResourceInfo resourceInfo = DEFAULT_RESOURCE_INFO;
    
    /**
     * Default constructor
     */
    public DataObjectInfo() {
    }

    /**
     * Sets the data object uri
     * @param uri the data object uri
     */
    public void setUri(String uri) {
        this.uri = uri;
    }

    
    /**
     * @return the uri of this data object
     */
    public String getUri() {
        return uri;
    }

    /**
     * Sets the object type
     * @param objectType the object type
     */    
    public void setObjectType(Registry.ObjectType objectType) {
        this.objectType = objectType;
    }

    /**
     * @return the object type MOD:CA Registry entry
     */
    public ObjectType getObjectType() {
        return objectType;
    }

    /**
     * @return the resource level at which this data object should reside
     */
    public ResourceInfo getResourceInfo() {
        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(ResourceInfo resourceInfo) {
        this.resourceInfo = resourceInfo;
    }

    /**
     * Sets the object area info
     * @param objectAreaInfo the object area info
     */
    public void setObjectAreaInfo(ObjectAreaInfo objectAreaInfo) {
        this.objectAreaInfo = objectAreaInfo;
    }

    /**
     * @return the object area info
     */
    public ObjectAreaInfo getObjectAreaInfo() {
        return this.objectAreaInfo;
    }

    /**
     * Sets the resource group settings using the given foreign attributes
     * @param foreignAttributes a mapping of element attributes names to values
     */
    public void setResourceInfoFromForeignAttributes(Map/*<QName, String>*/ foreignAttributes) {
        if (foreignAttributes != null && !foreignAttributes.isEmpty()) {
            this.resourceInfo = new ResourceInfo();
            QName resourceNameKey = new QName(AFPElementMapping.NAMESPACE, RESOURCE_NAME);
            String resourceName = (String)foreignAttributes.get(resourceNameKey);
            if (resourceName != null) {
                resourceInfo.setName(resourceName);
            }
            QName resourceLevelKey = new QName(AFPElementMapping.NAMESPACE, RESOURCE_LEVEL);
            if (foreignAttributes.containsKey(resourceLevelKey)) {
                String level = (String)foreignAttributes.get(resourceLevelKey);
                ResourceLevel resourceLevel = null;
                try {
                    resourceLevel = ResourceLevel.valueOf(level);
                    resourceInfo.setLevel(resourceLevel);
                    if (resourceLevel.isExternal()) {
                        QName resourceGroupFileKey = new QName(AFPElementMapping.NAMESPACE,
                                RESOURCE_GROUP_FILE);
                        String resourceExternalDest
                            = (String)foreignAttributes.get(resourceGroupFileKey);
                        if (resourceExternalDest == null) {
                            String msg = RESOURCE_GROUP_FILE + " not specified";
                            log.error(msg);
                            throw new UnsupportedOperationException(msg);
                        }
                        File resourceExternalGroupFile = new File(resourceExternalDest);
                        SecurityManager security = System.getSecurityManager();
                        try {
                            if (security != null) {
                                security.checkWrite(resourceExternalGroupFile.getPath());
                            }
                        } catch (SecurityException ex) {
                            log.error("unable to gain write access to external resource file: "
                                    + resourceExternalDest);                            
                        }
                            
                        try {
                            boolean exists = resourceExternalGroupFile.exists();
                            if (exists) {
                                log.warn("overwritting external resource file: "
                                        + resourceExternalDest);
                            }
                            resourceLevel.setExternalResourceGroupFile(resourceExternalGroupFile);
                        } catch (SecurityException ex) {
                            log.error("unable to gain read access to external resource file: "
                                    + resourceExternalDest);
                        }
                    }
                } catch (IllegalArgumentException e) {
                    // default to print-file resource level if invalid resource level provided
                    resourceLevel = new ResourceLevel(ResourceLevel.PRINT_FILE);
                    log.error(e.getMessage() + ", defaulting to '" + resourceLevel + "' level");
                }
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    public String toString() {
        return "uri=" + uri
            + (objectAreaInfo != null ? "objectAreaInfo=" + objectAreaInfo : "")
            + (objectType != null ? ", objectType=" + objectType : "")
            + (resourceInfo != null ? ", resourceInfo=" + resourceInfo : "");
    }
}