ActiveRecord/Castle.ActiveRecord/Framework/Internal/AssemblyXmlGenerator.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.ActiveRecord.Framework.Internal
  16 {
  17         using System.Collections;
  18         using System.Reflection;
  19         using System.Text;
  20
  21         /// <summary>
  22         /// Generate xml from assembly level attributes.
  23         /// This is useful if we need to have type-less configuration, such as imports, named queries, etc.
  24         /// </summary>
  25         public class AssemblyXmlGenerator
  26         {
  27                 private StringBuilder xml;
  28                 /// <summary>
  29                 /// Create a new instnace
  30                 /// </summary>
  31                 public AssemblyXmlGenerator()
  32                 {
  33                         Reset();
  34                 }
  35
  36                 /// <summary>
  37                 /// Reset this generator and prepare to generate xml from new assembly.
  38                 /// </summary>
  39                 private void Reset()
  40                 {
  41                         xml = new StringBuilder();
  42                 }
  43
  44                 /// <summary>
  45                 /// Generate XML from assembly attributes.
  46                 /// If it can't find relevant attributes, returns null.
  47                 /// </summary>
  48                 public string[] CreateXmlConfigurations(Assembly assembly)
  49                 {
  50                         object[] atts = assembly.GetCustomAttributes(true);
  51                         ArrayList namedQueries = new ArrayList();
  52                         ArrayList imports = new ArrayList();
  53                         ArrayList rawXml = new ArrayList();
  54                         foreach (object attribute in atts)
  55                         {
  56                                 if (attribute is HqlNamedQueryAttribute)
  57                                 {
  58                                         namedQueries.Add(attribute);
  59                                 }
  60                                 else if (attribute is ImportAttribute)
  61                                 {
  62                                         imports.Add(attribute);
  63                                 }
  64                                 else if (attribute is RawXmlMappingAttribute)
  65                                 {
  66                                         string[] result = ((RawXmlMappingAttribute)attribute).GetMappings();
  67                                         rawXml.AddRange(result);
  68                                 }
  69                         }
  70                         xml.Append(Constants.XmlPI);
  71                         xml.AppendFormat(Constants.XmlHeader, "", "");
  72                         //note that there is a meaning to the order of import vs. named queries, imports must come first.
  73                         foreach (ImportAttribute attribute in imports)
  74                         {
  75                                 AppendImport(attribute);
  76                         }
  77                         foreach (HqlNamedQueryAttribute attribute in namedQueries)
  78                         {
  79                                 AppendNamedQuery(attribute, assembly);
  80                         }
  81                         xml.AppendLine(Constants.XmlFooter);
  82                         bool hasQueriesOrImportsToAdd = namedQueries.Count != 0 || imports.Count != 0;
  83                         if (hasQueriesOrImportsToAdd)
  84                         {
  85                                 rawXml.Insert(0,xml.ToString());
  86                         }
  87                         Reset();
  88                         return (string[])rawXml.ToArray(typeof(string));
  89                 }
  90
  91                 private void AppendImport(ImportAttribute attribute)
  92                 {
  93                         xml.AppendFormat("<import class=\"{0}\" rename=\"{1}\"/>", XmlGenerationVisitor.MakeTypeName(attribute.Type), attribute.Rename);
  94                 }
  95
  96                 private void AppendNamedQuery(HqlNamedQueryAttribute attribute, Assembly assembly)
  97                 {
  98                         if (attribute.Name == "" || attribute.Query == "")
  99                         {
 100                                 throw new ActiveRecordException("Error generating XML for HqlNamedQuery in " + assembly.FullName +
 101                                                                                                 ". Query must have both name and query.");
 102                         }
 103
 104                         xml.AppendFormat(@"
 105         <query name='{0}'>
 106                  <![CDATA[{1}]]>
 107          </query>
 108 ", attribute.Name, attribute.Query);
 109
 110                 }
 111         }
 112 }