View Javadoc

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