Add SportInfo support for mlbrunsleadersxml.dtd.

[dead/htsn-import.git] / src / TSN / XmlImport.hs

diff --git a/src/TSN/XmlImport.hs b/src/TSN/XmlImport.hs
index 3791ab56ef19add5ec4d0638d94a4e26cec51b51..5693bd4e2d8841f670dbf76bcd006fa7e978d257 100644 (file)
--- a/src/TSN/XmlImport.hs
+++ b/src/TSN/XmlImport.hs
@@ -1,28 +1,94 @@
 {-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE GADTs #-}
 
+-- | Definition of the XmlImport class.
+--
 module TSN.XmlImport (
-  XmlImport(..) )
+  XmlImport(..),
+  XmlImportFk(..) )
 where
 
 import Database.Groundhog (
   AutoKey,
+  DefaultKey,
   insert,
+  insert_,
   insertByAll )
 import Database.Groundhog.Core ( PersistBackend, PersistEntity )
 
-import Xml ( FromXml(..) )
+import Xml ( FromXml(..), FromXmlFk(..), ToDb(..) )
 
 
+-- | In Groundhog, there is a typeclass of things you can insert into
+--   the database. What we usually have, though, is an XML
+--   representation of something that has a Groundhog analogue that we
+--   could insert into the database. It would be real nice if we could
+--   just insert the XML thing and not have to convert back and
+--   forth. That's what the 'XmlImport' class lets you do.
+--
+--   Moreover, there is a contraint on the class that the type must
+--   also be a member of the 'FromXml' class. This allows us to define
+--   default implementations of \"insert me\" generically. Given any
+--   XML thing that can be converted to a database thing, we just do
+--   the conversion and then insert normally (however Groundhog would
+--   do it).
+--
 class (FromXml a, PersistEntity (Db a)) => XmlImport a where
   -- | This is similar to the signature for Groundhog's 'insert'
   --   function, except the 'AutoKey' we return is for our 'Db'
   --   counterpart.
   insert_xml :: (PersistBackend m) => a ->  m (AutoKey (Db a))
-  insert_xml x = insert (from_xml x)
+  insert_xml = insert . from_xml
+
+  -- | Identical to 'insert_xml', except it doesn't return anything.
+  insert_xml_ :: (PersistBackend m) => a ->  m ()
+  insert_xml_ = insert_ . from_xml
 
   -- | Same rationale as 'insert_xml', except it uses 'insertByAll'.
   insertByAll_xml :: (PersistBackend m)
                   => a
                   -> m ( Either (AutoKey (Db a)) (AutoKey (Db a)) )
-  insertByAll_xml x = insertByAll (from_xml x)
+  insertByAll_xml = insertByAll . from_xml
+
+
+  -- | Try to insert the given object and get its primary key
+  --   back. Or, if there's a unique constraint violation, get the
+  --   primary key of the unique thing already present.
+  --
+  --   Note: we can switch to using fmap here as soon as Functor is a
+  --   superclass of Monad (PersistBackend is a Monad).
+  --
+  insert_xml_or_select :: (PersistBackend m)
+                       => a
+                       -> m (AutoKey (Db a))
+  insert_xml_or_select x = do
+    tmp <- insertByAll_xml x
+    return $ (either id id) tmp
+
+
+
+-- | A total copy of 'XmlImport' for instances of 'FromXmlFk'.
+--
+class (FromXmlFk a, PersistEntity (Db a)) => XmlImportFk a where
+  insert_xml_fk :: (PersistBackend m)
+                => DefaultKey (Parent a)
+                -> a
+                ->  m (AutoKey (Db a))
+  insert_xml_fk fk x = insert $ from_xml_fk fk x
+
+  insert_xml_fk_ :: (PersistBackend m) => DefaultKey (Parent a) -> a -> m ()
+  insert_xml_fk_ fk x = insert_ $ from_xml_fk fk x
+
+  insertByAll_xml_fk :: (PersistBackend m)
+                     => DefaultKey (Parent a)
+                     -> a
+                     -> m ( Either (AutoKey (Db a)) (AutoKey (Db a)) )
+  insertByAll_xml_fk fk x = insertByAll $ from_xml_fk fk x
+
+  insert_xml_or_select_fk :: (PersistBackend m)
+                          => DefaultKey (Parent a)
+                          -> a
+                          -> m (AutoKey (Db a))
+  insert_xml_or_select_fk fk x = do
+    tmp <- insertByAll_xml_fk fk x
+    return $ (either id id) tmp