Changeset 7109 for TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/attributevaluereader.py

Timestamp:

28/06/10 13:54:57 (11 years ago)

Author:

pjkersha

Message:

Incomplete - task 2: XACML-Security Integration

• updating epydoc ready for release.

File:

• TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/attributevaluereader.py (modified) (3 diffs)

TI12-security/trunk/ndg_xacml/ndg/xacml/parsers/etree/attributevaluereader.py

@@ -19 +19 @@
 class AttributeValueReader(ExpressionReader):
     '''ElementTree based XACML Expression type parser
+    
+    @cvar TYPE: XACML class type that this reader will read values into
+    @type TYPE: abc.ABCMeta
+    
+    @cvar FACTORY: factory function for returning an Attribute value type for a 
+    given XACML Attribute value URI
+    @type FACTORY: ndg.xacml.core.attributevalue.AttributeValueClassFactory
     '''
     TYPE = AttributeValue
@@ -27 +34 @@
         _parseExtension since AttributeValue class is virtual.  A sub-type can
         be instantiated only once the data type attribute is parsed
+        
+        @param obj: input object to parse
+        @type obj: ElementTree Element, or stream object
+        @return: new XACML attribute value instance
+        @rtype: ndg.xacml.core.attributevalue.AttributeValue derived type 
+        @raise XMLParseError: error reading element       
         """
         elem = super(AttributeValueReader, self)._parse(obj)
@@ -55 +68 @@
     
     def _parseExtension(self, elem, attributeValue):
+        """Parse XML Attribute value element
+        
+        @param elem: ElementTree XML element
+        @type elem: xml.etree.Element
+        
+        @param attributeValue: attribute selector to be updated with parsed
+        values
+        @type attributeValue: ndg.xacml.core.attributevalue.AttributeValue
+        
+        @raise XMLParseError: error parsing attribute ID XML attribute
+        """
         if elem.text is None:
             raise XMLParseError('No attribute value element found parsing %r' %