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
|
/*
* 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;
/**
* A resource level
*/
public class ResourceLevel {
/** page level **/
public static final int PAGE = 0;
/** page group level **/
public static final int PAGE_GROUP = 1;
/** document level **/
public static final int DOCUMENT = 2;
/** print file level **/
public static final int PRINT_FILE = 3;
/** external level **/
public static final int EXTERNAL = 4;
private static final String NAME_PAGE = "page";
private static final String NAME_PAGE_GROUP = "page-group";
private static final String NAME_DOCUMENT = "document";
private static final String NAME_PRINT_FILE = "print-file";
private static final String NAME_EXTERNAL = "external";
private static final String[] NAMES
= new String[] {NAME_PAGE, NAME_PAGE_GROUP, NAME_DOCUMENT, NAME_PRINT_FILE, NAME_EXTERNAL};
/**
* where the resource will reside in the AFP output
*/
private int level = PRINT_FILE; // default is print-file level
/**
* the external resource group file
*/
private File externalResourceGroupFile = null;
/**
* Sets the resource placement level within the AFP output
* @param lvl the resource level (page, page-group, document, print-file or external)
* @return true if the resource level was successfully set
*/
public static ResourceLevel valueOf(String lvl) {
ResourceLevel level = null;
for (int i = 0; i < NAMES.length; i++) {
if (NAMES[i].equals(lvl)) {
level = new ResourceLevel(i);
break;
}
}
if (lvl == null) {
throw new IllegalArgumentException("Unknown resource level '" + lvl + "'");
}
return level;
}
/**
* Main constructor
* @param level the resource level
*/
public ResourceLevel(int level) {
this.level = level;
}
/**
* @return true if this is a page level resource group
*/
public boolean isPage() {
return level == PAGE;
}
/**
* @return true if this is a page group level resource group
*/
public boolean isPageGroup() {
return level == PAGE_GROUP;
}
/**
* @return true if this is a document level resource group
*/
public boolean isDocument() {
return level == DOCUMENT;
}
/**
* @return true if this is an external level resource group
*/
public boolean isExternal() {
return level == EXTERNAL;
}
/**
* @return true if this is a print-file level resource group
*/
public boolean isPrintFile() {
return level == PRINT_FILE;
}
/**
* @return the external resource group file of this resource
*/
public File getExternalResourceGroupFile() {
return this.externalResourceGroupFile;
}
/**
* @return the destination file path of the external resource group file
*/
public String getExternalResourceGroupFilePath() {
if (externalResourceGroupFile != null) {
return externalResourceGroupFile.getAbsolutePath();
}
return null;
}
/**
* Sets the external destination of the resource
* @param file the external resource group file
*/
public void setExternalResourceGroupFile(File file) {
this.externalResourceGroupFile = file;
}
/**
* @return true if this resource has a defined external resource group file destination
*/
public boolean hasExternalResourceGroupFile() {
return getExternalResourceGroupFile() != null;
}
/** {@inheritDoc} */
public String toString() {
return NAMES[level] + (isExternal() ? ", file=" + externalResourceGroupFile : "");
}
}
|
