aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/render/afp/extensions/AbstractAFPExtensionObject.java
blob: c0e9c2c897d231eda8058a7fb665e1d70f1e9984 (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
/*
 * 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.extensions;

// FOP
import org.xml.sax.Attributes;
import org.xml.sax.Locator;

import org.apache.fop.apps.FOPException;
import org.apache.fop.fo.FONode;
import org.apache.fop.fo.PropertyList;
import org.apache.fop.fo.ValidationException;
import org.apache.fop.fo.extensions.ExtensionAttachment;

/**
 * Base class for the AFP-specific extension elements.
 */
public abstract class AbstractAFPExtensionObject extends FONode {

    /**
     * the AFP extension attachment
     */
    protected AFPExtensionAttachment extensionAttachment;

    /**
     * the element name of this extension
     */
    protected String name;

    /**
     * @see org.apache.fop.fo.FONode#FONode(FONode)
     * @param parent the parent formatting object
     * @param name the name of the afp element
     */
    public AbstractAFPExtensionObject(FONode parent, String name) {
        super(parent);
        this.name = name;
    }

    /**
     * {@inheritDoc}
     */
    protected void validateChildNode(Locator loc, String nsURI, String localName)
                throws ValidationException {
        if (FO_URI.equals(nsURI)) {
            invalidChildError(loc, nsURI, localName);
        }
    }

    /**
     * {@inheritDoc}
     */
    protected void characters(char[] data, int start, int length,
                                 PropertyList pList, Locator locator) throws FOPException {
        ((AFPExtensionAttachment)getExtensionAttachment()).setContent(
                new String(data, start, length));       
    }

    /**
     * {@inheritDoc}
     */
    public String getNamespaceURI() {
        return AFPElementMapping.NAMESPACE;
    }

    /**
     * {@inheritDoc}
     */
    public String getNormalNamespacePrefix() {
        return AFPElementMapping.NAMESPACE_PREFIX;
    }

    /**
     * {@inheritDoc}
     */
    public void processNode(String elementName, Locator locator,
                            Attributes attlist, PropertyList propertyList)
                                throws FOPException {
        getExtensionAttachment();
        String attr = attlist.getValue("name");
        if (attr != null && attr.length() > 0) {
            extensionAttachment.setName(attr);
        } else {
            throw new FOPException(elementName + " must have a name attribute.");
        }
        if (AFPElementMapping.INCLUDE_PAGE_SEGMENT.equals(elementName)) {
            attr = attlist.getValue("src");
            if (attr != null && attr.length() > 0) {
                extensionAttachment.setValue(attr);
            } else {
                throw new FOPException(elementName + " must have a src attribute.");
            }
        } else if (AFPElementMapping.TAG_LOGICAL_ELEMENT.equals(elementName)) {
            attr = attlist.getValue("value");
            if (attr != null && attr.length() > 0) {
                extensionAttachment.setValue(attr);
            } else {
                throw new FOPException(elementName + " must have a value attribute.");
            }
        }
    }
    
    /**
     * {@inheritDoc}
     */
    protected void endOfNode() throws FOPException {
        super.endOfNode();
    }

    /**
     * Instantiates extension attachment object
     * @return extension attachment
     */
    protected abstract ExtensionAttachment instantiateExtensionAttachment();

    /**
     * {@inheritDoc}
     */
    public ExtensionAttachment getExtensionAttachment() {
        if (extensionAttachment == null) {
            this.extensionAttachment = (AFPExtensionAttachment)instantiateExtensionAttachment();
        }
        return this.extensionAttachment;
    }

    /**
     * {@inheritDoc}
     */
    public String getLocalName() {
        return name;
    }
}