###############################################################################
##                                                                           ##
##                        ALEXANDRIA DIGITAL LIBRARY                         ##
##                 University of California at Santa Barbara                 ##
##                                                                           ##
## ------------------------------------------------------------------------- ##
##                                                                           ##
##     Copyright (c) 2005 by the Regents of the University of California     ##
##                            All rights reserved                            ##
##                                                                           ##
## Redistribution and use in source and binary forms, with or without        ##
## modification, are permitted provided that the following conditions are    ##
## met:                                                                      ##
##                                                                           ##
##     1. Redistributions of source code must retain the above copyright     ##
##        notice, this list of conditions, and the following disclaimer.     ##
##                                                                           ##
##     2. Redistributions in binary form must reproduce the above copyright  ##
##        notice, this list of conditions, and the following disclaimer in   ##
##        the documentation and/or other materials provided with the         ##
##        distribution.                                                      ##
##                                                                           ##
##     3. All advertising materials mentioning features or use of this       ##
##        software must display the following acknowledgement: This product  ##
##        includes software developed by the Alexandria Digital Library,     ##
##        University of California at Santa Barbara, and its contributors.   ##
##                                                                           ##
##     4. Neither the name of the University nor the names of its            ##
##        contributors may be used to endorse or promote products derived    ##
##        from this software without specific prior written permission.      ##
##                                                                           ##
## THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY ##
## EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED ##
## WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ARE   ##
## DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR  ##
## ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL    ##
## DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS   ##
## OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)     ##
## HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,       ##
## STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN  ##
## ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE           ##
## POSSIBILITY OF SUCH DAMAGE.                                               ##
##                                                                           ##
###############################################################################

# $Header: /export/home/gjanee/mm/bucket_types/RCS/hierarchical.py,v 1.1 2005/02/17 00:52:16 gjanee Exp $

# DESCRIPTION
#
#     The "hierarchical" bucket type.
#
# AUTHOR
#
#     Greg Janee
#     gjanee@alexandria.ucsb.edu
#
# HISTORY
#
#     $Log: hierarchical.py,v $
#     Revision 1.1  2005/02/17 00:52:16  gjanee
#     Initial revision
#

from ADL_mapper import bucketType, fatal, getVocabulary
from bucket_types.utils import checkValue, encodeField, fieldErrorClause

def _validate (bucket, field, value, strict):
    value = checkValue(bucket, "hierarchical", ["!!"], field, value, strict)
    if value == None: return None
    v = value[0]
    t = value[1]
    if getVocabulary(v) == None:
        if strict:
            fatal(("invalid value mapped to hierarchical bucket '%s'%s: " +\
                "unrecognized vocabulary: %s") % (bucket,
                fieldErrorClause(field), v))
        else:
            return None
    (buckets, terms) = getVocabulary(v)
    if bucket not in buckets:
        if strict:
            fatal(("invalid value mapped to hierarchical bucket '%s'%s: " +\
                "incompatible vocabulary: %s") % (bucket,
                fieldErrorClause(field), v))
        else:
            return None
    foundTerm = None
    for term in terms.keys():
        if t.lower() == term.lower():
            foundTerm = term
            break
    if foundTerm == None:
        if strict:
            fatal(("invalid value mapped to hierarchical bucket '%s'%s: " +\
                "unrecognized term from vocabulary '%s': %s") % (bucket,
                fieldErrorClause(field), v, t))
        else:
            return None
    return (field, (v, foundTerm))

def _encode (document, field, value):
    hv = document.createElement("hierarchical-value")
    encodeField(document, hv, field)
    t = document.createElement("term")
    t.setAttribute("vocabulary", value[0])
    t.appendChild(document.createTextNode(value[1]))
    hv.appendChild(t)
    return hv

bucketType("hierarchical", _validate, _encode)