MetadataXpp3Reader xref

View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.0.1 on 2009-09-09 03:30:24,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.artifact.repository.metadata.io.xpp3;
9   
10    //---------------------------------/
11   //- Imported classes and packages -/
12  //---------------------------------/
13  
14  import java.io.IOException;
15  import java.io.InputStream;
16  import java.io.Reader;
17  import java.text.DateFormat;
18  import java.util.Locale;
19  import org.apache.maven.artifact.repository.metadata.Metadata;
20  import org.apache.maven.artifact.repository.metadata.Plugin;
21  import org.apache.maven.artifact.repository.metadata.Snapshot;
22  import org.apache.maven.artifact.repository.metadata.Versioning;
23  import org.codehaus.plexus.util.ReaderFactory;
24  import org.codehaus.plexus.util.xml.pull.MXParser;
25  import org.codehaus.plexus.util.xml.pull.XmlPullParser;
26  import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
27  
28  /**
29   * Class MetadataXpp3Reader.
30   * 
31   * @version $Revision$ $Date$
32   */
33  public class MetadataXpp3Reader
34  {
35  
36        //--------------------------/
37       //- Class/Member Variables -/
38      //--------------------------/
39  
40      /**
41       * If set the parser will be loaded with all single characters
42       * from the XHTML specification.
43       * The entities used:
44       * <ul>
45       * <li>http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent</li>
46       * <li>http://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent</li>
47       * <li>http://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent</li>
48       * </ul>
49       */
50      private boolean addDefaultEntities = true;
51  
52  
53        //-----------/
54       //- Methods -/
55      //-----------/
56  
57      /**
58       * Method checkFieldWithDuplicate.
59       * 
60       * @param parser
61       * @param parsed
62       * @param alias
63       * @param tagName
64       * @throws XmlPullParserException
65       * @return boolean
66       */
67      private boolean checkFieldWithDuplicate( XmlPullParser parser, String tagName, String alias, java.util.Set parsed )
68          throws XmlPullParserException
69      {
70          if ( !( parser.getName().equals( tagName ) || parser.getName().equals( alias ) ) )
71          {
72              return false;
73          }
74          if ( parsed.contains( tagName ) )
75          {
76              throw new XmlPullParserException( "Duplicated tag: '" + tagName + "'", parser, null );
77          }
78          parsed.add( tagName );
79          return true;
80      } //-- boolean checkFieldWithDuplicate( XmlPullParser, String, String, java.util.Set )
81  
82      /**
83       * Returns the state of the "add default entities" flag.
84       * 
85       * @return boolean
86       */
87      public boolean getAddDefaultEntities()
88      {
89          return addDefaultEntities;
90      } //-- boolean getAddDefaultEntities()
91  
92      /**
93       * Method getBooleanValue.
94       * 
95       * @param s
96       * @param parser
97       * @param attribute
98       * @throws XmlPullParserException
99       * @return boolean
100      */
101     private boolean getBooleanValue( String s, String attribute, XmlPullParser parser )
102         throws XmlPullParserException
103     {
104         return getBooleanValue( s, attribute, parser, null );
105     } //-- boolean getBooleanValue( String, String, XmlPullParser )
106 
107     /**
108      * Method getBooleanValue.
109      * 
110      * @param s
111      * @param defaultValue
112      * @param parser
113      * @param attribute
114      * @throws XmlPullParserException
115      * @return boolean
116      */
117     private boolean getBooleanValue( String s, String attribute, XmlPullParser parser, String defaultValue )
118         throws XmlPullParserException
119     {
120         if ( s != null && s.length() != 0 )
121         {
122             return Boolean.valueOf( s ).booleanValue();
123         }
124         if ( defaultValue != null )
125         {
126             return Boolean.valueOf( defaultValue ).booleanValue();
127         }
128         return false;
129     } //-- boolean getBooleanValue( String, String, XmlPullParser, String )
130 
131     /**
132      * Method getByteValue.
133      * 
134      * @param s
135      * @param strict
136      * @param parser
137      * @param attribute
138      * @throws XmlPullParserException
139      * @return byte
140      */
141     private byte getByteValue( String s, String attribute, XmlPullParser parser, boolean strict )
142         throws XmlPullParserException
143     {
144         if ( s != null )
145         {
146             try
147             {
148                 return Byte.valueOf( s ).byteValue();
149             }
150             catch ( NumberFormatException e )
151             {
152                 if ( strict )
153                 {
154                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a byte", parser, null );
155                 }
156             }
157         }
158         return 0;
159     } //-- byte getByteValue( String, String, XmlPullParser, boolean )
160 
161     /**
162      * Method getCharacterValue.
163      * 
164      * @param s
165      * @param parser
166      * @param attribute
167      * @throws XmlPullParserException
168      * @return char
169      */
170     private char getCharacterValue( String s, String attribute, XmlPullParser parser )
171         throws XmlPullParserException
172     {
173         if ( s != null )
174         {
175             return s.charAt( 0 );
176         }
177         return 0;
178     } //-- char getCharacterValue( String, String, XmlPullParser )
179 
180     /**
181      * Method getDateValue.
182      * 
183      * @param s
184      * @param parser
185      * @param attribute
186      * @throws XmlPullParserException
187      * @return Date
188      */
189     private java.util.Date getDateValue( String s, String attribute, XmlPullParser parser )
190         throws XmlPullParserException
191     {
192         return getDateValue( s, attribute, null, parser );
193     } //-- java.util.Date getDateValue( String, String, XmlPullParser )
194 
195     /**
196      * Method getDateValue.
197      * 
198      * @param s
199      * @param parser
200      * @param dateFormat
201      * @param attribute
202      * @throws XmlPullParserException
203      * @return Date
204      */
205     private java.util.Date getDateValue( String s, String attribute, String dateFormat, XmlPullParser parser )
206         throws XmlPullParserException
207     {
208         if ( s != null )
209         {
210             String effectiveDateFormat = dateFormat;
211             if ( dateFormat == null )
212             {
213                 effectiveDateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSS";
214             }
215             if ( "long".equals( effectiveDateFormat ) )
216             {
217                 try
218                 {
219                     return new java.util.Date( Long.parseLong( s ) );
220                 }
221                 catch ( NumberFormatException e )
222                 {
223                     throw new XmlPullParserException( e.getMessage() );
224                 }
225             }
226             else
227             {
228                 try
229                 {
230                     DateFormat dateParser = new java.text.SimpleDateFormat( effectiveDateFormat, Locale.US );
231                     return dateParser.parse( s );
232                 }
233                 catch ( java.text.ParseException e )
234                 {
235                     throw new XmlPullParserException( e.getMessage() );
236                 }
237             }
238         }
239         return null;
240     } //-- java.util.Date getDateValue( String, String, String, XmlPullParser )
241 
242     /**
243      * Method getDoubleValue.
244      * 
245      * @param s
246      * @param strict
247      * @param parser
248      * @param attribute
249      * @throws XmlPullParserException
250      * @return double
251      */
252     private double getDoubleValue( String s, String attribute, XmlPullParser parser, boolean strict )
253         throws XmlPullParserException
254     {
255         if ( s != null )
256         {
257             try
258             {
259                 return Double.valueOf( s ).doubleValue();
260             }
261             catch ( NumberFormatException e )
262             {
263                 if ( strict )
264                 {
265                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a floating point number", parser, null );
266                 }
267             }
268         }
269         return 0;
270     } //-- double getDoubleValue( String, String, XmlPullParser, boolean )
271 
272     /**
273      * Method getFloatValue.
274      * 
275      * @param s
276      * @param strict
277      * @param parser
278      * @param attribute
279      * @throws XmlPullParserException
280      * @return float
281      */
282     private float getFloatValue( String s, String attribute, XmlPullParser parser, boolean strict )
283         throws XmlPullParserException
284     {
285         if ( s != null )
286         {
287             try
288             {
289                 return Float.valueOf( s ).floatValue();
290             }
291             catch ( NumberFormatException e )
292             {
293                 if ( strict )
294                 {
295                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a floating point number", parser, null );
296                 }
297             }
298         }
299         return 0;
300     } //-- float getFloatValue( String, String, XmlPullParser, boolean )
301 
302     /**
303      * Method getIntegerValue.
304      * 
305      * @param s
306      * @param strict
307      * @param parser
308      * @param attribute
309      * @throws XmlPullParserException
310      * @return int
311      */
312     private int getIntegerValue( String s, String attribute, XmlPullParser parser, boolean strict )
313         throws XmlPullParserException
314     {
315         if ( s != null )
316         {
317             try
318             {
319                 return Integer.valueOf( s ).intValue();
320             }
321             catch ( NumberFormatException e )
322             {
323                 if ( strict )
324                 {
325                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be an integer", parser, null );
326                 }
327             }
328         }
329         return 0;
330     } //-- int getIntegerValue( String, String, XmlPullParser, boolean )
331 
332     /**
333      * Method getLongValue.
334      * 
335      * @param s
336      * @param strict
337      * @param parser
338      * @param attribute
339      * @throws XmlPullParserException
340      * @return long
341      */
342     private long getLongValue( String s, String attribute, XmlPullParser parser, boolean strict )
343         throws XmlPullParserException
344     {
345         if ( s != null )
346         {
347             try
348             {
349                 return Long.valueOf( s ).longValue();
350             }
351             catch ( NumberFormatException e )
352             {
353                 if ( strict )
354                 {
355                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a long integer", parser, null );
356                 }
357             }
358         }
359         return 0;
360     } //-- long getLongValue( String, String, XmlPullParser, boolean )
361 
362     /**
363      * Method getRequiredAttributeValue.
364      * 
365      * @param s
366      * @param strict
367      * @param parser
368      * @param attribute
369      * @throws XmlPullParserException
370      * @return String
371      */
372     private String getRequiredAttributeValue( String s, String attribute, XmlPullParser parser, boolean strict )
373         throws XmlPullParserException
374     {
375         if ( s == null )
376         {
377             if ( strict )
378             {
379                 throw new XmlPullParserException( "Missing required value for attribute '" + attribute + "'", parser, null );
380             }
381         }
382         return s;
383     } //-- String getRequiredAttributeValue( String, String, XmlPullParser, boolean )
384 
385     /**
386      * Method getShortValue.
387      * 
388      * @param s
389      * @param strict
390      * @param parser
391      * @param attribute
392      * @throws XmlPullParserException
393      * @return short
394      */
395     private short getShortValue( String s, String attribute, XmlPullParser parser, boolean strict )
396         throws XmlPullParserException
397     {
398         if ( s != null )
399         {
400             try
401             {
402                 return Short.valueOf( s ).shortValue();
403             }
404             catch ( NumberFormatException e )
405             {
406                 if ( strict )
407                 {
408                     throw new XmlPullParserException( "Unable to parse element '" + attribute + "', must be a short integer", parser, null );
409                 }
410             }
411         }
412         return 0;
413     } //-- short getShortValue( String, String, XmlPullParser, boolean )
414 
415     /**
416      * Method getTrimmedValue.
417      * 
418      * @param s
419      * @return String
420      */
421     private String getTrimmedValue( String s )
422     {
423         if ( s != null )
424         {
425             s = s.trim();
426         }
427         return s;
428     } //-- String getTrimmedValue( String )
429 
430     /**
431      * Method parseMetadata.
432      * 
433      * @param tagName
434      * @param strict
435      * @param parser
436      * @throws IOException
437      * @throws XmlPullParserException
438      * @return Metadata
439      */
440     private Metadata parseMetadata( String tagName, XmlPullParser parser, boolean strict )
441         throws IOException, XmlPullParserException
442     {
443         Metadata metadata = new Metadata();
444         java.util.Set parsed = new java.util.HashSet();
445         int eventType = parser.getEventType();
446         boolean foundRoot = false;
447         while ( eventType != XmlPullParser.END_DOCUMENT )
448         {
449             if ( eventType == XmlPullParser.START_TAG )
450             {
451                 if ( parser.getName().equals( tagName ) )
452                 {
453                     foundRoot = true;
454                 }
455                 else if ( strict && ! foundRoot )
456                 {
457                     throw new XmlPullParserException( "Expected root element '" + tagName + "' but found '" + parser.getName() + "'", parser, null );
458                 }
459                 else if ( checkFieldWithDuplicate( parser, "groupId", null, parsed ) )
460                 {
461                     metadata.setGroupId( getTrimmedValue( parser.nextText() ) );
462                 }
463                 else if ( checkFieldWithDuplicate( parser, "artifactId", null, parsed ) )
464                 {
465                     metadata.setArtifactId( getTrimmedValue( parser.nextText() ) );
466                 }
467                 else if ( checkFieldWithDuplicate( parser, "version", null, parsed ) )
468                 {
469                     metadata.setVersion( getTrimmedValue( parser.nextText() ) );
470                 }
471                 else if ( checkFieldWithDuplicate( parser, "versioning", null, parsed ) )
472                 {
473                     metadata.setVersioning( parseVersioning( "versioning", parser, strict ) );
474                 }
475                 else if ( checkFieldWithDuplicate( parser, "plugins", null, parsed ) )
476                 {
477                     java.util.List plugins = new java.util.ArrayList/*<Plugin>*/();
478                     metadata.setPlugins( plugins );
479                     while ( parser.nextTag() == XmlPullParser.START_TAG )
480                     {
481                         if ( parser.getName().equals( "plugin" ) )
482                         {
483                             plugins.add( parsePlugin( "plugin", parser, strict ) );
484                         }
485                         else if ( strict )
486                         {
487                             throw new XmlPullParserException( "Unrecognised association: '" + parser.getName() + "'", parser, null );
488                         }
489                         else
490                         {
491                             // swallow up to end tag since this is not valid
492                             while ( parser.next() != XmlPullParser.END_TAG ) {}
493                         }
494                     }
495                 }
496                 else if ( strict )
497                 {
498                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
499                 }
500             }
501             eventType = parser.next();
502         }
503         return metadata;
504     } //-- Metadata parseMetadata( String, XmlPullParser, boolean )
505 
506     /**
507      * Method parsePlugin.
508      * 
509      * @param tagName
510      * @param strict
511      * @param parser
512      * @throws IOException
513      * @throws XmlPullParserException
514      * @return Plugin
515      */
516     private Plugin parsePlugin( String tagName, XmlPullParser parser, boolean strict )
517         throws IOException, XmlPullParserException
518     {
519         Plugin plugin = new Plugin();
520         java.util.Set parsed = new java.util.HashSet();
521         while ( parser.nextTag() == XmlPullParser.START_TAG )
522         {
523             if ( checkFieldWithDuplicate( parser, "name", null, parsed ) )
524             {
525                 plugin.setName( getTrimmedValue( parser.nextText() ) );
526             }
527             else if ( checkFieldWithDuplicate( parser, "prefix", null, parsed ) )
528             {
529                 plugin.setPrefix( getTrimmedValue( parser.nextText() ) );
530             }
531             else if ( checkFieldWithDuplicate( parser, "artifactId", null, parsed ) )
532             {
533                 plugin.setArtifactId( getTrimmedValue( parser.nextText() ) );
534             }
535             else
536             {
537                 if ( strict )
538                 {
539                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
540                 }
541                 else
542                 {
543                     // swallow up to end tag since this is not valid
544                     while ( parser.next() != XmlPullParser.END_TAG ) {}
545                 }
546             }
547         }
548         return plugin;
549     } //-- Plugin parsePlugin( String, XmlPullParser, boolean )
550 
551     /**
552      * Method parseSnapshot.
553      * 
554      * @param tagName
555      * @param strict
556      * @param parser
557      * @throws IOException
558      * @throws XmlPullParserException
559      * @return Snapshot
560      */
561     private Snapshot parseSnapshot( String tagName, XmlPullParser parser, boolean strict )
562         throws IOException, XmlPullParserException
563     {
564         Snapshot snapshot = new Snapshot();
565         java.util.Set parsed = new java.util.HashSet();
566         while ( parser.nextTag() == XmlPullParser.START_TAG )
567         {
568             if ( checkFieldWithDuplicate( parser, "timestamp", null, parsed ) )
569             {
570                 snapshot.setTimestamp( getTrimmedValue( parser.nextText() ) );
571             }
572             else if ( checkFieldWithDuplicate( parser, "buildNumber", null, parsed ) )
573             {
574                 snapshot.setBuildNumber( getIntegerValue( getTrimmedValue( parser.nextText() ), "buildNumber", parser, strict ) );
575             }
576             else if ( checkFieldWithDuplicate( parser, "localCopy", null, parsed ) )
577             {
578                 snapshot.setLocalCopy( getBooleanValue( getTrimmedValue( parser.nextText() ), "localCopy", parser, "false" ) );
579             }
580             else
581             {
582                 if ( strict )
583                 {
584                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
585                 }
586                 else
587                 {
588                     // swallow up to end tag since this is not valid
589                     while ( parser.next() != XmlPullParser.END_TAG ) {}
590                 }
591             }
592         }
593         return snapshot;
594     } //-- Snapshot parseSnapshot( String, XmlPullParser, boolean )
595 
596     /**
597      * Method parseVersioning.
598      * 
599      * @param tagName
600      * @param strict
601      * @param parser
602      * @throws IOException
603      * @throws XmlPullParserException
604      * @return Versioning
605      */
606     private Versioning parseVersioning( String tagName, XmlPullParser parser, boolean strict )
607         throws IOException, XmlPullParserException
608     {
609         Versioning versioning = new Versioning();
610         java.util.Set parsed = new java.util.HashSet();
611         while ( parser.nextTag() == XmlPullParser.START_TAG )
612         {
613             if ( checkFieldWithDuplicate( parser, "latest", null, parsed ) )
614             {
615                 versioning.setLatest( getTrimmedValue( parser.nextText() ) );
616             }
617             else if ( checkFieldWithDuplicate( parser, "release", null, parsed ) )
618             {
619                 versioning.setRelease( getTrimmedValue( parser.nextText() ) );
620             }
621             else if ( checkFieldWithDuplicate( parser, "snapshot", null, parsed ) )
622             {
623                 versioning.setSnapshot( parseSnapshot( "snapshot", parser, strict ) );
624             }
625             else if ( checkFieldWithDuplicate( parser, "versions", null, parsed ) )
626             {
627                 java.util.List versions = new java.util.ArrayList/*<String>*/();
628                 versioning.setVersions( versions );
629                 while ( parser.nextTag() == XmlPullParser.START_TAG )
630                 {
631                     if ( parser.getName().equals( "version" ) )
632                     {
633                         versions.add( getTrimmedValue( parser.nextText() ) );
634                     }
635                     else if ( strict )
636                     {
637                         throw new XmlPullParserException( "Unrecognised association: '" + parser.getName() + "'", parser, null );
638                     }
639                     else
640                     {
641                         // swallow up to end tag since this is not valid
642                         while ( parser.next() != XmlPullParser.END_TAG ) {}
643                     }
644                 }
645             }
646             else if ( checkFieldWithDuplicate( parser, "lastUpdated", null, parsed ) )
647             {
648                 versioning.setLastUpdated( getTrimmedValue( parser.nextText() ) );
649             }
650             else
651             {
652                 if ( strict )
653                 {
654                     throw new XmlPullParserException( "Unrecognised tag: '" + parser.getName() + "'", parser, null );
655                 }
656                 else
657                 {
658                     // swallow up to end tag since this is not valid
659                     while ( parser.next() != XmlPullParser.END_TAG ) {}
660                 }
661             }
662         }
663         return versioning;
664     } //-- Versioning parseVersioning( String, XmlPullParser, boolean )
665 
666     /**
667      * @see ReaderFactory#newXmlReader
668      * 
669      * @param reader
670      * @param strict
671      * @throws IOException
672      * @throws XmlPullParserException
673      * @return Metadata
674      */
675     public Metadata read( Reader reader, boolean strict )
676         throws IOException, XmlPullParserException
677     {
678         XmlPullParser parser = new MXParser();
679 
680         parser.setInput( reader );
681 
682         if ( addDefaultEntities )
683         {
684             // ----------------------------------------------------------------------
685             // Latin 1 entities
686             // ----------------------------------------------------------------------
687 
688             parser.defineEntityReplacementText( "nbsp", "\u00a0" );
689             parser.defineEntityReplacementText( "iexcl", "\u00a1" );
690             parser.defineEntityReplacementText( "cent", "\u00a2" );
691             parser.defineEntityReplacementText( "pound", "\u00a3" );
692             parser.defineEntityReplacementText( "curren", "\u00a4" );
693             parser.defineEntityReplacementText( "yen", "\u00a5" );
694             parser.defineEntityReplacementText( "brvbar", "\u00a6" );
695             parser.defineEntityReplacementText( "sect", "\u00a7" );
696             parser.defineEntityReplacementText( "uml", "\u00a8" );
697             parser.defineEntityReplacementText( "copy", "\u00a9" );
698             parser.defineEntityReplacementText( "ordf", "\u00aa" );
699             parser.defineEntityReplacementText( "laquo", "\u00ab" );
700             parser.defineEntityReplacementText( "not", "\u00ac" );
701             parser.defineEntityReplacementText( "shy", "\u00ad" );
702             parser.defineEntityReplacementText( "reg", "\u00ae" );
703             parser.defineEntityReplacementText( "macr", "\u00af" );
704             parser.defineEntityReplacementText( "deg", "\u00b0" );
705             parser.defineEntityReplacementText( "plusmn", "\u00b1" );
706             parser.defineEntityReplacementText( "sup2", "\u00b2" );
707             parser.defineEntityReplacementText( "sup3", "\u00b3" );
708             parser.defineEntityReplacementText( "acute", "\u00b4" );
709             parser.defineEntityReplacementText( "micro", "\u00b5" );
710             parser.defineEntityReplacementText( "para", "\u00b6" );
711             parser.defineEntityReplacementText( "middot", "\u00b7" );
712             parser.defineEntityReplacementText( "cedil", "\u00b8" );
713             parser.defineEntityReplacementText( "sup1", "\u00b9" );
714             parser.defineEntityReplacementText( "ordm", "\u00ba" );
715             parser.defineEntityReplacementText( "raquo", "\u00bb" );
716             parser.defineEntityReplacementText( "frac14", "\u00bc" );
717             parser.defineEntityReplacementText( "frac12", "\u00bd" );
718             parser.defineEntityReplacementText( "frac34", "\u00be" );
719             parser.defineEntityReplacementText( "iquest", "\u00bf" );
720             parser.defineEntityReplacementText( "Agrave", "\u00c0" );
721             parser.defineEntityReplacementText( "Aacute", "\u00c1" );
722             parser.defineEntityReplacementText( "Acirc", "\u00c2" );
723             parser.defineEntityReplacementText( "Atilde", "\u00c3" );
724             parser.defineEntityReplacementText( "Auml", "\u00c4" );
725             parser.defineEntityReplacementText( "Aring", "\u00c5" );
726             parser.defineEntityReplacementText( "AElig", "\u00c6" );
727             parser.defineEntityReplacementText( "Ccedil", "\u00c7" );
728             parser.defineEntityReplacementText( "Egrave", "\u00c8" );
729             parser.defineEntityReplacementText( "Eacute", "\u00c9" );
730             parser.defineEntityReplacementText( "Ecirc", "\u00ca" );
731             parser.defineEntityReplacementText( "Euml", "\u00cb" );
732             parser.defineEntityReplacementText( "Igrave", "\u00cc" );
733             parser.defineEntityReplacementText( "Iacute", "\u00cd" );
734             parser.defineEntityReplacementText( "Icirc", "\u00ce" );
735             parser.defineEntityReplacementText( "Iuml", "\u00cf" );
736             parser.defineEntityReplacementText( "ETH", "\u00d0" );
737             parser.defineEntityReplacementText( "Ntilde", "\u00d1" );
738             parser.defineEntityReplacementText( "Ograve", "\u00d2" );
739             parser.defineEntityReplacementText( "Oacute", "\u00d3" );
740             parser.defineEntityReplacementText( "Ocirc", "\u00d4" );
741             parser.defineEntityReplacementText( "Otilde", "\u00d5" );
742             parser.defineEntityReplacementText( "Ouml", "\u00d6" );
743             parser.defineEntityReplacementText( "times", "\u00d7" );
744             parser.defineEntityReplacementText( "Oslash", "\u00d8" );
745             parser.defineEntityReplacementText( "Ugrave", "\u00d9" );
746             parser.defineEntityReplacementText( "Uacute", "\u00da" );
747             parser.defineEntityReplacementText( "Ucirc", "\u00db" );
748             parser.defineEntityReplacementText( "Uuml", "\u00dc" );
749             parser.defineEntityReplacementText( "Yacute", "\u00dd" );
750             parser.defineEntityReplacementText( "THORN", "\u00de" );
751             parser.defineEntityReplacementText( "szlig", "\u00df" );
752             parser.defineEntityReplacementText( "agrave", "\u00e0" );
753             parser.defineEntityReplacementText( "aacute", "\u00e1" );
754             parser.defineEntityReplacementText( "acirc", "\u00e2" );
755             parser.defineEntityReplacementText( "atilde", "\u00e3" );
756             parser.defineEntityReplacementText( "auml", "\u00e4" );
757             parser.defineEntityReplacementText( "aring", "\u00e5" );
758             parser.defineEntityReplacementText( "aelig", "\u00e6" );
759             parser.defineEntityReplacementText( "ccedil", "\u00e7" );
760             parser.defineEntityReplacementText( "egrave", "\u00e8" );
761             parser.defineEntityReplacementText( "eacute", "\u00e9" );
762             parser.defineEntityReplacementText( "ecirc", "\u00ea" );
763             parser.defineEntityReplacementText( "euml", "\u00eb" );
764             parser.defineEntityReplacementText( "igrave", "\u00ec" );
765             parser.defineEntityReplacementText( "iacute", "\u00ed" );
766             parser.defineEntityReplacementText( "icirc", "\u00ee" );
767             parser.defineEntityReplacementText( "iuml", "\u00ef" );
768             parser.defineEntityReplacementText( "eth", "\u00f0" );
769             parser.defineEntityReplacementText( "ntilde", "\u00f1" );
770             parser.defineEntityReplacementText( "ograve", "\u00f2" );
771             parser.defineEntityReplacementText( "oacute", "\u00f3" );
772             parser.defineEntityReplacementText( "ocirc", "\u00f4" );
773             parser.defineEntityReplacementText( "otilde", "\u00f5" );
774             parser.defineEntityReplacementText( "ouml", "\u00f6" );
775             parser.defineEntityReplacementText( "divide", "\u00f7" );
776             parser.defineEntityReplacementText( "oslash", "\u00f8" );
777             parser.defineEntityReplacementText( "ugrave", "\u00f9" );
778             parser.defineEntityReplacementText( "uacute", "\u00fa" );
779             parser.defineEntityReplacementText( "ucirc", "\u00fb" );
780             parser.defineEntityReplacementText( "uuml", "\u00fc" );
781             parser.defineEntityReplacementText( "yacute", "\u00fd" );
782             parser.defineEntityReplacementText( "thorn", "\u00fe" );
783             parser.defineEntityReplacementText( "yuml", "\u00ff" );
784 
785             // ----------------------------------------------------------------------
786             // Special entities
787             // ----------------------------------------------------------------------
788 
789             parser.defineEntityReplacementText( "OElig", "\u0152" );
790             parser.defineEntityReplacementText( "oelig", "\u0153" );
791             parser.defineEntityReplacementText( "Scaron", "\u0160" );
792             parser.defineEntityReplacementText( "scaron", "\u0161" );
793             parser.defineEntityReplacementText( "Yuml", "\u0178" );
794             parser.defineEntityReplacementText( "circ", "\u02c6" );
795             parser.defineEntityReplacementText( "tilde", "\u02dc" );
796             parser.defineEntityReplacementText( "ensp", "\u2002" );
797             parser.defineEntityReplacementText( "emsp", "\u2003" );
798             parser.defineEntityReplacementText( "thinsp", "\u2009" );
799             parser.defineEntityReplacementText( "zwnj", "\u200c" );
800             parser.defineEntityReplacementText( "zwj", "\u200d" );
801             parser.defineEntityReplacementText( "lrm", "\u200e" );
802             parser.defineEntityReplacementText( "rlm", "\u200f" );
803             parser.defineEntityReplacementText( "ndash", "\u2013" );
804             parser.defineEntityReplacementText( "mdash", "\u2014" );
805             parser.defineEntityReplacementText( "lsquo", "\u2018" );
806             parser.defineEntityReplacementText( "rsquo", "\u2019" );
807             parser.defineEntityReplacementText( "sbquo", "\u201a" );
808             parser.defineEntityReplacementText( "ldquo", "\u201c" );
809             parser.defineEntityReplacementText( "rdquo", "\u201d" );
810             parser.defineEntityReplacementText( "bdquo", "\u201e" );
811             parser.defineEntityReplacementText( "dagger", "\u2020" );
812             parser.defineEntityReplacementText( "Dagger", "\u2021" );
813             parser.defineEntityReplacementText( "permil", "\u2030" );
814             parser.defineEntityReplacementText( "lsaquo", "\u2039" );
815             parser.defineEntityReplacementText( "rsaquo", "\u203a" );
816             parser.defineEntityReplacementText( "euro", "\u20ac" );
817 
818             // ----------------------------------------------------------------------
819             // Symbol entities
820             // ----------------------------------------------------------------------
821 
822             parser.defineEntityReplacementText( "fnof", "\u0192" );
823             parser.defineEntityReplacementText( "Alpha", "\u0391" );
824             parser.defineEntityReplacementText( "Beta", "\u0392" );
825             parser.defineEntityReplacementText( "Gamma", "\u0393" );
826             parser.defineEntityReplacementText( "Delta", "\u0394" );
827             parser.defineEntityReplacementText( "Epsilon", "\u0395" );
828             parser.defineEntityReplacementText( "Zeta", "\u0396" );
829             parser.defineEntityReplacementText( "Eta", "\u0397" );
830             parser.defineEntityReplacementText( "Theta", "\u0398" );
831             parser.defineEntityReplacementText( "Iota", "\u0399" );
832             parser.defineEntityReplacementText( "Kappa", "\u039a" );
833             parser.defineEntityReplacementText( "Lambda", "\u039b" );
834             parser.defineEntityReplacementText( "Mu", "\u039c" );
835             parser.defineEntityReplacementText( "Nu", "\u039d" );
836             parser.defineEntityReplacementText( "Xi", "\u039e" );
837             parser.defineEntityReplacementText( "Omicron", "\u039f" );
838             parser.defineEntityReplacementText( "Pi", "\u03a0" );
839             parser.defineEntityReplacementText( "Rho", "\u03a1" );
840             parser.defineEntityReplacementText( "Sigma", "\u03a3" );
841             parser.defineEntityReplacementText( "Tau", "\u03a4" );
842             parser.defineEntityReplacementText( "Upsilon", "\u03a5" );
843             parser.defineEntityReplacementText( "Phi", "\u03a6" );
844             parser.defineEntityReplacementText( "Chi", "\u03a7" );
845             parser.defineEntityReplacementText( "Psi", "\u03a8" );
846             parser.defineEntityReplacementText( "Omega", "\u03a9" );
847             parser.defineEntityReplacementText( "alpha", "\u03b1" );
848             parser.defineEntityReplacementText( "beta", "\u03b2" );
849             parser.defineEntityReplacementText( "gamma", "\u03b3" );
850             parser.defineEntityReplacementText( "delta", "\u03b4" );
851             parser.defineEntityReplacementText( "epsilon", "\u03b5" );
852             parser.defineEntityReplacementText( "zeta", "\u03b6" );
853             parser.defineEntityReplacementText( "eta", "\u03b7" );
854             parser.defineEntityReplacementText( "theta", "\u03b8" );
855             parser.defineEntityReplacementText( "iota", "\u03b9" );
856             parser.defineEntityReplacementText( "kappa", "\u03ba" );
857             parser.defineEntityReplacementText( "lambda", "\u03bb" );
858             parser.defineEntityReplacementText( "mu", "\u03bc" );
859             parser.defineEntityReplacementText( "nu", "\u03bd" );
860             parser.defineEntityReplacementText( "xi", "\u03be" );
861             parser.defineEntityReplacementText( "omicron", "\u03bf" );
862             parser.defineEntityReplacementText( "pi", "\u03c0" );
863             parser.defineEntityReplacementText( "rho", "\u03c1" );
864             parser.defineEntityReplacementText( "sigmaf", "\u03c2" );
865             parser.defineEntityReplacementText( "sigma", "\u03c3" );
866             parser.defineEntityReplacementText( "tau", "\u03c4" );
867             parser.defineEntityReplacementText( "upsilon", "\u03c5" );
868             parser.defineEntityReplacementText( "phi", "\u03c6" );
869             parser.defineEntityReplacementText( "chi", "\u03c7" );
870             parser.defineEntityReplacementText( "psi", "\u03c8" );
871             parser.defineEntityReplacementText( "omega", "\u03c9" );
872             parser.defineEntityReplacementText( "thetasym", "\u03d1" );
873             parser.defineEntityReplacementText( "upsih", "\u03d2" );
874             parser.defineEntityReplacementText( "piv", "\u03d6" );
875             parser.defineEntityReplacementText( "bull", "\u2022" );
876             parser.defineEntityReplacementText( "hellip", "\u2026" );
877             parser.defineEntityReplacementText( "prime", "\u2032" );
878             parser.defineEntityReplacementText( "Prime", "\u2033" );
879             parser.defineEntityReplacementText( "oline", "\u203e" );
880             parser.defineEntityReplacementText( "frasl", "\u2044" );
881             parser.defineEntityReplacementText( "weierp", "\u2118" );
882             parser.defineEntityReplacementText( "image", "\u2111" );
883             parser.defineEntityReplacementText( "real", "\u211c" );
884             parser.defineEntityReplacementText( "trade", "\u2122" );
885             parser.defineEntityReplacementText( "alefsym", "\u2135" );
886             parser.defineEntityReplacementText( "larr", "\u2190" );
887             parser.defineEntityReplacementText( "uarr", "\u2191" );
888             parser.defineEntityReplacementText( "rarr", "\u2192" );
889             parser.defineEntityReplacementText( "darr", "\u2193" );
890             parser.defineEntityReplacementText( "harr", "\u2194" );
891             parser.defineEntityReplacementText( "crarr", "\u21b5" );
892             parser.defineEntityReplacementText( "lArr", "\u21d0" );
893             parser.defineEntityReplacementText( "uArr", "\u21d1" );
894             parser.defineEntityReplacementText( "rArr", "\u21d2" );
895             parser.defineEntityReplacementText( "dArr", "\u21d3" );
896             parser.defineEntityReplacementText( "hArr", "\u21d4" );
897             parser.defineEntityReplacementText( "forall", "\u2200" );
898             parser.defineEntityReplacementText( "part", "\u2202" );
899             parser.defineEntityReplacementText( "exist", "\u2203" );
900             parser.defineEntityReplacementText( "empty", "\u2205" );
901             parser.defineEntityReplacementText( "nabla", "\u2207" );
902             parser.defineEntityReplacementText( "isin", "\u2208" );
903             parser.defineEntityReplacementText( "notin", "\u2209" );
904             parser.defineEntityReplacementText( "ni", "\u220b" );
905             parser.defineEntityReplacementText( "prod", "\u220f" );
906             parser.defineEntityReplacementText( "sum", "\u2211" );
907             parser.defineEntityReplacementText( "minus", "\u2212" );
908             parser.defineEntityReplacementText( "lowast", "\u2217" );
909             parser.defineEntityReplacementText( "radic", "\u221a" );
910             parser.defineEntityReplacementText( "prop", "\u221d" );
911             parser.defineEntityReplacementText( "infin", "\u221e" );
912             parser.defineEntityReplacementText( "ang", "\u2220" );
913             parser.defineEntityReplacementText( "and", "\u2227" );
914             parser.defineEntityReplacementText( "or", "\u2228" );
915             parser.defineEntityReplacementText( "cap", "\u2229" );
916             parser.defineEntityReplacementText( "cup", "\u222a" );
917             parser.defineEntityReplacementText( "int", "\u222b" );
918             parser.defineEntityReplacementText( "there4", "\u2234" );
919             parser.defineEntityReplacementText( "sim", "\u223c" );
920             parser.defineEntityReplacementText( "cong", "\u2245" );
921             parser.defineEntityReplacementText( "asymp", "\u2248" );
922             parser.defineEntityReplacementText( "ne", "\u2260" );
923             parser.defineEntityReplacementText( "equiv", "\u2261" );
924             parser.defineEntityReplacementText( "le", "\u2264" );
925             parser.defineEntityReplacementText( "ge", "\u2265" );
926             parser.defineEntityReplacementText( "sub", "\u2282" );
927             parser.defineEntityReplacementText( "sup", "\u2283" );
928             parser.defineEntityReplacementText( "nsub", "\u2284" );
929             parser.defineEntityReplacementText( "sube", "\u2286" );
930             parser.defineEntityReplacementText( "supe", "\u2287" );
931             parser.defineEntityReplacementText( "oplus", "\u2295" );
932             parser.defineEntityReplacementText( "otimes", "\u2297" );
933             parser.defineEntityReplacementText( "perp", "\u22a5" );
934             parser.defineEntityReplacementText( "sdot", "\u22c5" );
935             parser.defineEntityReplacementText( "lceil", "\u2308" );
936             parser.defineEntityReplacementText( "rceil", "\u2309" );
937             parser.defineEntityReplacementText( "lfloor", "\u230a" );
938             parser.defineEntityReplacementText( "rfloor", "\u230b" );
939             parser.defineEntityReplacementText( "lang", "\u2329" );
940             parser.defineEntityReplacementText( "rang", "\u232a" );
941             parser.defineEntityReplacementText( "loz", "\u25ca" );
942             parser.defineEntityReplacementText( "spades", "\u2660" );
943             parser.defineEntityReplacementText( "clubs", "\u2663" );
944             parser.defineEntityReplacementText( "hearts", "\u2665" );
945             parser.defineEntityReplacementText( "diams", "\u2666" );
946 
947         }
948 
949         parser.next();
950         return parseMetadata( "metadata", parser, strict );
951     } //-- Metadata read( Reader, boolean )
952 
953     /**
954      * @see ReaderFactory#newXmlReader
955      * 
956      * @param reader
957      * @throws IOException
958      * @throws XmlPullParserException
959      * @return Metadata
960      */
961     public Metadata read( Reader reader )
962         throws IOException, XmlPullParserException
963     {
964         return read( reader, true );
965     } //-- Metadata read( Reader )
966 
967     /**
968      * Method read.
969      * 
970      * @param in
971      * @param strict
972      * @throws IOException
973      * @throws XmlPullParserException
974      * @return Metadata
975      */
976     public Metadata read( InputStream in, boolean strict )
977         throws IOException, XmlPullParserException
978     {
979         Reader reader = ReaderFactory.newXmlReader( in );
980 
981         return read( reader, strict );
982     } //-- Metadata read( InputStream, boolean )
983 
984     /**
985      * Method read.
986      * 
987      * @param in
988      * @throws IOException
989      * @throws XmlPullParserException
990      * @return Metadata
991      */
992     public Metadata read( InputStream in )
993         throws IOException, XmlPullParserException
994     {
995         Reader reader = ReaderFactory.newXmlReader( in );
996 
997         return read( reader );
998     } //-- Metadata read( InputStream )
999 
1000     /**
1001      * Sets the state of the "add default entities" flag.
1002      * 
1003      * @param addDefaultEntities
1004      */
1005     public void setAddDefaultEntities( boolean addDefaultEntities )
1006     {
1007         this.addDefaultEntities = addDefaultEntities;
1008     } //-- void setAddDefaultEntities( boolean )
1009 
1010 
1011 }