X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2FXml.hs;h=bbb72be0348d1864ddf3094fda6173769ef247f1;hb=83902c16cf946f81ea733f707d432632aa124084;hp=3242dacd8b2a7a69c997acb527846dfaaeb0ff75;hpb=c4f82d3ee2488f8574e4719ec3c0f99b52ff649b;p=dead%2Fhtsn-import.git diff --git a/src/Xml.hs b/src/Xml.hs index 3242dac..bbb72be 100644 --- a/src/Xml.hs +++ b/src/Xml.hs @@ -1,3 +1,4 @@ +{-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE TypeFamilies #-} -- | General XML stuff. @@ -5,6 +6,8 @@ module Xml ( DtdName(..), FromXml(..), + FromXmlFk(..), + ToDb(..), parse_opts, pickle_unpickle, unpickleable ) @@ -12,6 +15,7 @@ where -- System imports. import Control.Exception ( SomeException(..), catch ) +import Database.Groundhog.Core ( PersistEntity(..) ) import Text.XML.HXT.Core ( (>>>), (/>), @@ -27,6 +31,13 @@ import Text.XML.HXT.Core ( xunpickleVal, yes ) +-- | Common associated type shared by 'FromXml' and 'FromXmlFk'. This +-- basically just forces the client to define the \"database +-- version\" of his type. +-- +class ToDb a where + -- | Each instance @a@ must declare its associated database type @Db a@. + type Db a :: * -- | A typeclass for XML types that can be converted into an -- associated database type. The story behind this is long, but @@ -39,14 +50,27 @@ import Text.XML.HXT.Core ( -- to get the database type from the XML type that we have to define -- for HXT. -- -class FromXml a where - -- | Each instance @a@ must declare its associated database type @Db a@. - type Db a :: * - - -- | And provide a function for getting a @Db a@ out of an @a@. +class (ToDb a) => FromXml a where + -- | A function for getting a @Db a@ out of an @a@. from_xml :: a -> Db a +-- | Some database types cannot be constructed from the XML type +-- alone; they must be supplied a foreign key to a parent object +-- first. Members of this class can be converted from an XML +-- representation to a database representation in this manner. +-- +class (ToDb a) => FromXmlFk a where + -- | The type of our parent object, i.e. to the type to whom our + -- foreign key will point. + type Parent a :: * + + -- | The function that produces a @Db a@ out of a foreign key and an + -- @a@. The parameter order makes it easier to map this function + -- over a bunch of things. + from_xml_fk :: DefaultKey (Parent a) -> a -> Db a + + -- | Represents the DTD filename (\"SYSTEM\") part of the DOCTYPE -- definition. newtype DtdName = DtdName String