MetaData.h

Go to the documentation of this file.

//-*****************************************************************************
//
// Copyright (c) 2009-2011,
//  Sony Pictures Imageworks Inc. and
//  Industrial Light & Magic, a division of Lucasfilm Entertainment Company Ltd.
//
// 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 Sony Pictures Imageworks, nor
// Industrial Light & Magic, nor the names of their 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.
//
//-*****************************************************************************
 
#ifndef Alembic_AbcCoreAbstract_MetaData_h
#define Alembic_AbcCoreAbstract_MetaData_h
 
#include <Alembic/AbcCoreAbstract/Foundation.h>
 
namespace Alembic {
namespace AbcCoreAbstract {
namespace ALEMBIC_VERSION_NS {
 
//-*****************************************************************************
class MetaData
{
public:
    //-*************************************************************************
    // TYPEDEFS
    //-*************************************************************************

    typedef Alembic::Util::TokenMap token_map_type;

    typedef token_map_type::key_type key_type;

    typedef token_map_type::data_type data_type;

    typedef token_map_type::value_type value_type;

    typedef token_map_type::const_reference const_reference;

    typedef token_map_type::const_iterator const_iterator;

    typedef token_map_type::const_reverse_iterator const_reverse_iterator;
 
    //-*************************************************************************
    // CONSTRUCTION
    //-*************************************************************************

    MetaData() {}

    MetaData( const MetaData &iCopy ) : m_tokenMap( iCopy.m_tokenMap ) {}

    MetaData& operator=( const MetaData &iCopy )
    {
        m_tokenMap = iCopy.m_tokenMap;
        return *this;
    }
 
    //-*************************************************************************
    // SERIALIZATION/DESERIALIZATION
    //-*************************************************************************

    void deserialize( const std::string &iFrom )
    {
        m_tokenMap.clear();
        m_tokenMap.setUnique( iFrom, ';', '=', true );
    }

    std::string serialize() const
    {
        return m_tokenMap.get( ';', '=', true );
    }
 
    //-*************************************************************************
    // SIZE
    //-*************************************************************************
    size_t size() const { return m_tokenMap.size(); }
 
    //-*************************************************************************
    // ITERATION
    //-*************************************************************************

    const_iterator begin() const { return m_tokenMap.begin(); }

    const_iterator end() const { return m_tokenMap.end(); }

    const_reverse_iterator rbegin() const { return m_tokenMap.rbegin(); }

    const_reverse_iterator rend() const { return m_tokenMap.rend(); }
 
    //-*************************************************************************
    // ACCESS/ASSIGNMENT
    //-*************************************************************************

    void set( const std::string &iKey, const std::string &iData )
    {
        m_tokenMap.setValue( iKey, iData );
    }

    void setUnique( const std::string &iKey, const std::string &iData )
    {
        std::string found = m_tokenMap.value( iKey );
        if ( found == "" )
        {
            m_tokenMap.setValue( iKey, iData );
        }
        else if ( found != iData )
        {
            ABCA_THROW( "Key: " << iKey << " already exists in MetaData" );
        }
    }

    std::string get( const std::string &iKey ) const
    {
        return m_tokenMap.value( iKey );
    }

    std::string getRequired( const std::string &iKey ) const
    {
        std::string ret = m_tokenMap.value( iKey );
        if ( ret == "" )
        {
            ABCA_THROW( "Key: " << iKey << " did not exist in MetaData" );
        }
        return ret;
    }

    void append( const MetaData &iMetaData )
    {
        for ( const_iterator iter = iMetaData.begin();
              iter != iMetaData.end(); ++iter )
        {
            set( (*iter).first, (*iter).second );
        }
    }

    void appendOnlyUnique( const MetaData &iMetaData )
    {
        for ( const_iterator iter = iMetaData.begin();
              iter != iMetaData.end(); ++iter )
        {
            if ( !m_tokenMap.tokenExists( (*iter).first ) )
            {
                set( (*iter).first, (*iter).second );
            }
        }
    }

    void appendUnique( const MetaData &iMetaData )
    {
        for ( const_iterator iter = iMetaData.begin();
              iter != iMetaData.end(); ++iter )
        {
            setUnique( (*iter).first, (*iter).second );
        }
    }
 
    //-*************************************************************************
    // MATCHING
    // Simple matching for now, we'll save regex stuff for later.
    //-*************************************************************************

    bool matches( const MetaData &iMetaData ) const
    {
        for ( const_iterator iter = iMetaData.begin();
              iter != iMetaData.end(); ++iter )
        {
            if ( get( (*iter).first ) != (*iter).second )
            {
                return false;
            }
        }
        return true;
    }

    bool matchesOverlap( const MetaData &iMetaData ) const
    {
        for ( const_iterator iter = iMetaData.begin();
              iter != iMetaData.end(); ++iter )
        {
            std::string found = get( (*iter).first );
            if ( found != "" && found != (*iter).second )
            {
                return false;
            }
        }
        return true;
    }

    bool matchesExactly( const MetaData &iMetaData ) const
    {
        return m_tokenMap.exactMatch( iMetaData.m_tokenMap );
    }
 
private:
    Alembic::Util::TokenMap m_tokenMap;
};
 
} // End namespace ALEMBIC_VERSION_NS
 
using namespace ALEMBIC_VERSION_NS;
 
} // End namespace AbcCoreAbstract
} // End namespace Alembic
 
#endif