source: mauRepo/MolesManager/trunk/cedaMoles/MolesManager/db/partyIndexes.py @ 8486

'''
BSD Licence
Copyright (c) 2012, Science & Technology Facilities Council (STFC)
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, 
        this list of conditions and the following disclaimer.
    * 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.
    * Neither the name of the Science & Technology Facilities Council (STFC) 
        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 COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.

Created on 3 Aug 2012

@author: mnagni
'''
from cedaMoles.libs.epb import EPB
from sqlalchemy import Table, Column, ForeignKey, Integer, String, event
from sqlalchemy.orm import mapper
from ea_model.moles3_4.utilities.mo_responsiblepartyinfo import MO_ResponsiblePartyInfo

class PartyIndexes(object):
    '''
    Allows to assign on a MO_ResponsiblePartyInfo basis an index 
    to the the referred MO_Party instances.
    
     # The primary key refers to the MO_ResponsiblePartyInfo.id 
     # The sorted_party column shall contain a string formatted as 
         IDParty(1):partyOrder(1), IDParty(2):partyOrder(2), .....
         
       where 
         # IDParty(x) is a MO_Party.id in the mo_responsiblepartyinfo.party list
         # partyOrder(x) is the assigned index
    '''

    def __init__(self):
        self.id = None
        self.party_order = None

def associateMOParty_indexes(metadata):
    '''
    Creates the table used to store the index associated per ResponsiblePartyIngo 
    to each referenced party.
    
    **Parameters**
         * metadata: an SQLAlchemy Metadata instance
    '''
    party_indexes_table = Table('party_indexes', metadata, \
                       Column('id', Integer, ForeignKey('mo_responsiblepartyinfo.id'), \
                              primary_key=True, unique=True),
                       Column('party_orders', String))
    mapper(PartyIndexes, party_indexes_table)
    metadata.create_all()
    event.listen(MO_ResponsiblePartyInfo, 'load', __associateIndexes)

def addPartyIndexes(responsiblePartyInfo, session):
    '''
    Associates to a MO_ResponsiblePartyInfo entity a PartyIndexes entity
    
    **Parameters**
        * responsiblePartyInfo: the MO_ResponsiblePartyInfo instance
        * session: an SQLAlchemy session instance
    '''
    pi = createAssociateIndexes(responsiblePartyInfo)
    session.add(pi)
    #session.flush()

def updatePartyIndexes(responsiblePartyInfo, session):
    '''
    Updates a PartyIndexes entity associated with a MO_ResponsiblePartyInfo entity 
    
    **Parameters**
        * responsiblePartyInfo: the MO_ResponsiblePartyInfo instance
        * session: an SQLAlchemy session instance
    '''
    partyIndex = session.query(PartyIndexes).get(responsiblePartyInfo.id)
    #uses this method just as utility
    pi = createAssociateIndexes(responsiblePartyInfo)
    partyIndex.party_orders = pi.party_orders
    session.expunge(pi)
    #session.flush()

def deletePartyIndexes(responsiblePartyInfo, session):
    '''
    Deletes a PartyIndexes entity associated with a MO_ResponsiblePartyInfo entity 
    
    **Parameters**
        * responsiblePartyInfo: the MO_ResponsiblePartyInfo instance
        * session: an SQLAlchemy session instance
    '''
    partyIndex = session.query(PartyIndexes).get(responsiblePartyInfo.id)
    session.delete(partyIndex)
    #session.flush()


def __associateIndexes(target, content):
    """
    Associates to a responsiblePartyInfo instance an "party_order" attribute.
    The method is associated when SQLAlchemy load a MO_ResponsiblePartyInfo instance

    **Parameters**
        * target: the MO_ResponsiblePartyInfo instance
        * content: an SQLAlchemy content instance                 
    """
    partyIndex = EPB.search(PartyIndexes, target.id, content.session)
    _associateIndexes(target, partyIndex)

def _associateIndexes(responsiblePartyInfo, partyIndex):
    """
    Associates to a responsiblePartyInfo instance an "party_order" attribute.
    This method is separated from the associateIndexes method purely for unittest purpose.
    
    **Parameters**
        * responsiblePartyInfo: the MO_ResponsiblePartyInfo instance
        * partyIndex: a string formatted like '1:1, 2:3, 3:2' where the pair #:# represents
        the partyID:orderIndex        
    """
    if partyIndex is None:
        return
    pi = dict((x.split(':')[0], x.split(':')[1]) for x in partyIndex.party_orders.split(','))
    for party in responsiblePartyInfo.party:
        if pi.has_key(str(party.id)):
            party.party_order = int(pi[str(party.id)]) 


def createAssociateIndexes(responsiblePartyInfo):
    """
    Creates from MO_ResponsiblePartyInfo instance a PartyIndexes instance.
    The PartyIndexes instance reads the MO_ResponsiblePartyInfo.party instances
    and for each of them try to read their `party_order` attribute.
    If `party_order` does not exists the methods assign automatically an incremental 
    index for each MO_Party
    
    **Parameters**
        * responsiblePartyInfo: the MO_ResponsiblePartyInfo instance
        
    **Return**
        * a PartyIndexes instance        
    """
    pi = PartyIndexes()
    pi.id = getattr(responsiblePartyInfo, 'id', None)
    
    order = []
    index = set([-1])
    for party in responsiblePartyInfo.party:
        pindex = max(index) + 1        
        if hasattr(party, 'party_order'):
            pindex = getattr(party, 'party_order')                
        order.append('%s:%s,' % (party.id, pindex))
        index.add(pindex)        
    party_orders = ''.join(order)[:-1]
    pi.party_orders = party_orders
    return pi