View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.rss.service.type.atom;
35  
36  import com.sun.syndication.feed.WireFeed;
37  import com.sun.syndication.feed.atom.Entry;
38  import com.sun.syndication.feed.atom.Feed;
39  
40  import fr.paris.lutece.plugins.rss.service.type.AbstractFeedTypeProvider;
41  import fr.paris.lutece.portal.business.rss.IFeedResource;
42  import fr.paris.lutece.portal.business.rss.IFeedResourceItem;
43  
44  import java.util.List;
45  
46  
47  /**
48   *
49   * AtomFeedTypeProvider
50   *
51   */
52  public abstract class AbstractAtomFeedTypeProvider extends AbstractFeedTypeProvider
53  {
54      /**
55      * Gets the atom entries
56      * @param listItems the items
57      * @param nMaxItems max item
58      * @return the entries
59      */
60      public abstract List<Entry> getATOMEntries( List<IFeedResourceItem> listItems, int nMaxItems );
61  
62      /**
63      * Builds an ATOM {@link Entry}
64      * @param resourceItem the item
65      * @return the entry
66      */
67      public abstract Entry getATOMEntry( IFeedResourceItem resourceItem );
68  
69      /**
70       * {@inheritDoc}
71       */
72      public WireFeed getWireFeed( String strFeedType, IFeedResource resource, String strEncoding, int nMaxItems )
73      {
74          // ATOM
75          Feed feed = new Feed( strFeedType );
76          feed.setLanguage( resource.getLanguage(  ) );
77          feed.setTitle( resource.getTitle(  ) );
78          feed.setEncoding( strEncoding );
79  
80          // items
81          feed.setEntries( getATOMEntries( resource.getItems(  ), nMaxItems ) );
82  
83          return feed;
84      }
85  }