source: TI02-CSML/trunk/parser/CSMLdocBuilder.py @ 1282

#!/usr/bin/env python

"""The class CSMLdocBuild handles the construction of a CSMLdocument.at a higher level than direct parser interaction
"""

from cElementTree import *
from Parser import *
import elementtree.ElementTree as etree
import sys
import urlparse
import string


def isURI(uri):
    """ a very simple function to test if a string is a uri 
    if ;// appears in the first 12 characters it is probably a uri """
    #TODO - a decent uri check!    
    result = False
    if string.find(uri[:12], '://') != -1:
        result = True
    return result


  ######################################################
## The class CSMLdocBuild handles the construction of a CSMLdocument.at a higher level than direct parser interaction.
  ######################################################

class CSMLdocBuild:
    def __init__(docID, docMetaDataProperty):
        #initialise a new document
        #Create an Empty Dataset
        self.ds = Dataset()
        #Set objects as attributes of dataset
               
        #if docMetaDataProperty is a URI, set it as href attribute if MetaDataProperty instance,
        #else set it as a text attribute of a MetaDataProperty instance.
        mdp=MetaDataProperty()
        if isURI(docMetaDataProperty):
            mdp.href=docMetaDataProperty
        else: 
            mdp.text = docMetaDataProperty
        self.ds.metaDataProperty= [mdp]
        #set the id
        self.ds.id=docID
        self.dm=[] #empty list to hold definition members (e.g. UnitDefinitions)
        self.fm=[] #empty list to hold feature members (e.g. GridFeatures, PointFeatures)
        self.ad=[] #empty list to hold array descriptors (e.g. NetCDFExtract)
        #the dataset is now initialised. now you can add features/defintions/arraydescriptors
        #using the methods supplied.
        #when finished building CSML objects call the consolidate method to return the document.       
        
    #separate build classes for each feature type
    def buildPointFeature(self):
        pass
        return feat
            
    def buildProfileFeature(self):
        pass
        return feat

    def buildGridFeature(self):
        pass
        return feat
            
    def buildPointSeriesFeature(self):
        pass
        return feat
            
    def buildProfileSeriesFeature(self):
        pass
        return feat

    def buildGridSeriesFeature(self):
        pass
        return feat
                        
    def buildTrajectoryFeature(self):
        pass
        return feat
    
    def addFeature(self,featureID):
        #Pass a feature and have it appended to the feature collection.
        pass

    def addFileExtract(self):
        #handles the addition of file extract classes (can probably get away with one method for all types of extracts)
        pass
    
    def removeFileExtract(self):
        #not implemented yet
        pass
        
    def removeFeature(self,featureID):
        #not implemented yet.
        pass
    def addDefintion(self):
        #not implemented yet. - may need separate methods for different defintion types?
        pass
    
    def removeDefintion(self):
        #not implemented yet.
        pass
    def consolidate(self):
        #when you have finished building the document, need to consolidate it and return a CSML document.
        return csmldoc