File: DefaultXmlDocumentInfo.java

package info (click to toggle)
libxml-java 1.1.7-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 544 kB
  • sloc: java: 4,760; xml: 1,011; makefile: 10
file content (179 lines) | stat: -rw-r--r-- 4,755 bytes parent folder | download | duplicates (3)
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
/*
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program 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.
 *
 * Copyright (c) 2006 - 2009 Object Refinery Ltd, Pentaho Corporation and Contributors.  All rights reserved.
 */

package org.pentaho.reporting.libraries.xmlns.parser;

import org.xml.sax.Attributes;

/**
 * A data class that holds all relevant information about a XML document to make a decision on what parser
 * to use to interpret the XML content.
 *
 * @author Thomas Morgner
 */
public class DefaultXmlDocumentInfo implements XmlDocumentInfo
{
  private String rootElement;
  private String rootElementNameSpace;
  private String publicDTDId;
  private String systemDTDId;
  private String defaultNameSpace;
  private Attributes rootElementAttributes;
  
  /**
   * Default-Constructor.
   */
  public DefaultXmlDocumentInfo()
  {
  }

  /**
   * Returns the tag name of the root-level element.
   *
   * @return the root-tag-name.
   */
  public String getRootElement()
  {
    return rootElement;
  }

  /**
   * Defines the tag name of the root-level element.
   *
   * @param rootElement the root-tag-name.
   */
  public void setRootElement(final String rootElement)
  {
    this.rootElement = rootElement;
  }

  /**
   * Returns the namespace URI for the root-element of the document.
   *
   * @return the namespace of the root-element.
   */
  public String getRootElementNameSpace()
  {
    return rootElementNameSpace;
  }

  /**
   * Defines the namespace URI for the root-element of the document.
   *
   * @param rootElementNameSpace the namespace of the root-element.
   */
  public void setRootElementNameSpace(final String rootElementNameSpace)
  {
    this.rootElementNameSpace = rootElementNameSpace;
  }

  public Attributes getRootElementAttributes()
  {
    return rootElementAttributes;
  }

  public void setRootElementAttributes(final Attributes rootElementAttributes)
  {
    this.rootElementAttributes = rootElementAttributes;
  }

  /**
   * Returns the Public-ID of the Document's DTD (if there's any).
   *
   * @return the public id.
   */
  public String getPublicDTDId()
  {
    return publicDTDId;
  }

  /**
   * Defines the Public-ID of the Document's DTD (if there's any).
   *
   * @param publicDTDId the public id.
   */
  public void setPublicDTDId(final String publicDTDId)
  {
    this.publicDTDId = publicDTDId;
  }

  /**
   * Returns the System-ID of the document's DTD.
   *
   * @return the system-id.
   */
  public String getSystemDTDId()
  {
    return systemDTDId;
  }

  /**
   * Defines the System-ID of the document's DTD.
   *
   * @param systemDTDId the system-id.
   */
  public void setSystemDTDId(final String systemDTDId)
  {
    this.systemDTDId = systemDTDId;
  }

  /**
   * Returns a string representation of the document info. This is for debugging purposes only.
   *
   * @return the string version of the document info.
   */
  public String toString()
  {
    final StringBuffer buffer = new StringBuffer(120);
    buffer.append("XmlDocumentInfo={rootElementTag=");
    buffer.append(rootElement);
    buffer.append(", rootElementNS=");
    buffer.append(rootElementNameSpace);
    buffer.append(", SystemDTD-ID=");
    buffer.append(systemDTDId);
    buffer.append(", PublicDTD-ID=");
    buffer.append(publicDTDId);
    buffer.append(", defaultnamespace=");
    buffer.append(defaultNameSpace);
    buffer.append('}');
    return buffer.toString();
  }

  /**
   * Returns the default-namespace declared on the root-element. It is
   * not guaranteed that this information is filled until a XmlFactoryModule
   * has been selected.
   *
   * @return the default-namespace.
   */
  public String getDefaultNameSpace()
  {
    return defaultNameSpace;
  }

  /**
   * Defines the default-namespace declared on the root-element. It is
   * not guaranteed that this information is filled until a XmlFactoryModule
   * has been selected.
   *
   * @param defaultNameSpace the default-namespace.
   */
  public void setDefaultNameSpace(final String defaultNameSpace)
  {
    this.defaultNameSpace = defaultNameSpace;
  }
}