forms/source/xforms/namedcollection.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: namedcollection.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _NAMEDCOLLECTION_HXX
  32 #define _NAMEDCOLLECTION_HXX
  33
  34 #include <collection.hxx>
  35 #include <cppuhelper/implbase1.hxx>
  36 #include <com/sun/star/container/XNameAccess.hpp>
  37
  38 #include <algorithm>
  39
  40 template<class T>
  41 class NamedCollection : public cppu::ImplInheritanceHelper1<
  42                             Collection<T>,
  43                             com::sun::star::container::XNameAccess>
  44 {
  45     using Collection<T>::maItems;
  46     using Collection<T>::getItem;
  47     using Collection<T>::hasItem;
  48
  49 public:
  50     NamedCollection() {}
  51     virtual ~NamedCollection() {}
  52
  53     const T& getItem( const rtl::OUString& rName ) const
  54     {
  55         OSL_ENSURE( hasItem( rName ), "invalid name" );
  56         return *findItem( rName );
  57     }
  58
  59     bool hasItem( const rtl::OUString& rName ) const
  60     {
  61         return findItem( rName ) != maItems.end();
  62     }
  63
  64     typedef com::sun::star::uno::Sequence<rtl::OUString> Names_t;
  65     Names_t getNames() const
  66     {
  67         // iterate over members, and collect all those that have names
  68         std::vector<rtl::OUString> aNames;
  69         for( typename std::vector<T>::const_iterator aIter = maItems.begin();
  70              aIter != maItems.end();
  71              aIter++ )
  72         {
  73             com::sun::star::uno::Reference<com::sun::star::container::XNamed>
  74                 xNamed( *aIter, com::sun::star::uno::UNO_QUERY );
  75             if( xNamed.is() )
  76                 aNames.push_back( xNamed->getName() );
  77         }
  78
  79         // copy names to Sequence and return
  80         Names_t aResult( aNames.size() );
  81         rtl::OUString* pStrings = aResult.getArray();
  82         std::copy( aNames.begin(), aNames.end(), pStrings );
  83
  84         return aResult;
  85     }
  86
  87 protected:
  88     typename std::vector<T>::const_iterator findItem( const rtl::OUString& rName ) const
  89     {
  90         for( typename std::vector<T>::const_iterator aIter = maItems.begin();
  91              aIter != maItems.end();
  92              aIter++ )
  93         {
  94             com::sun::star::uno::Reference<com::sun::star::container::XNamed>
  95                 xNamed( *aIter, com::sun::star::uno::UNO_QUERY );
  96             if( xNamed.is()  &&  xNamed->getName() == rName )
  97                 return aIter;
  98         }
  99         return maItems.end();
 100     }
 101
 102 public:
 103
 104     // XElementAccess
 105     virtual typename Collection<T>::Type_t SAL_CALL getElementType()
 106         throw( typename Collection<T>::RuntimeException_t )
 107     {
 108         return Collection<T>::getElementType();
 109     }
 110
 111     virtual sal_Bool SAL_CALL hasElements()
 112         throw( typename Collection<T>::RuntimeException_t )
 113     {
 114         return Collection<T>::hasElements();
 115     }
 116
 117     // XNameAccess : XElementAccess
 118     virtual typename Collection<T>::Any_t SAL_CALL getByName(
 119         const rtl::OUString& aName )
 120         throw( typename Collection<T>::NoSuchElementException_t,
 121                typename Collection<T>::WrappedTargetException_t,
 122                typename Collection<T>::RuntimeException_t )
 123     {
 124         if( hasItem( aName ) )
 125             return com::sun::star::uno::makeAny( getItem( aName ) );
 126         else
 127             throw typename Collection<T>::NoSuchElementException_t();
 128
 129     }
 130
 131     virtual Names_t SAL_CALL getElementNames()
 132         throw( typename Collection<T>::RuntimeException_t )
 133     {
 134         return getNames();
 135     }
 136
 137     virtual sal_Bool SAL_CALL hasByName(
 138         const rtl::OUString& aName )
 139         throw( typename Collection<T>::RuntimeException_t )
 140     {
 141         return hasItem( aName ) ? sal_True : sal_False;
 142     }
 143 };
 144
 145 #endif