001    /*
002     * JBoss, Home of Professional Open Source.
003     * Copyright 2008, Red Hat Middleware LLC, and individual contributors
004     * as indicated by the @author tags. See the copyright.txt file in the
005     * distribution for a full listing of individual contributors. 
006     *
007     * This is free software; you can redistribute it and/or modify it
008     * under the terms of the GNU Lesser General Public License as
009     * published by the Free Software Foundation; either version 2.1 of
010     * the License, or (at your option) any later version.
011     *
012     * This software is distributed in the hope that it will be useful,
013     * but WITHOUT ANY WARRANTY; without even the implied warranty of
014     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015     * Lesser General Public License for more details.
016     *
017     * You should have received a copy of the GNU Lesser General Public
018     * License along with this software; if not, write to the Free
019     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021     */
022    package org.jboss.dna.connector.federation.contribution;
023    
024    import java.util.Iterator;
025    import java.util.LinkedList;
026    import java.util.List;
027    import net.jcip.annotations.Immutable;
028    import org.jboss.dna.graph.Location;
029    import org.jboss.dna.graph.properties.DateTime;
030    import org.jboss.dna.graph.properties.Property;
031    
032    /**
033     * The contribution of a source to the information for a single federated node.
034     * 
035     * @author Randall Hauch
036     */
037    @Immutable
038    public class NodeContribution extends MultiPropertyContribution {
039    
040        /**
041         * This is the first version of this class. See the documentation of MergePlan.serialVersionUID.
042         */
043        private static final long serialVersionUID = 1L;
044    
045        private List<Location> children;
046    
047        /**
048         * Create a contribution of node properties and children from the source with the supplied name.
049         * 
050         * @param sourceName the name of the source, which may not be null or blank
051         * @param locationInSource the location in the source for this contributed information; may not be null
052         * @param expirationTime the time (in UTC) after which this contribution should be considered expired, or null if there is no
053         *        expiration time
054         * @param properties the properties from the source; may not be null
055         * @param children the children from the source; may not be null or empty
056         */
057        public NodeContribution( String sourceName,
058                                 Location locationInSource,
059                                 DateTime expirationTime,
060                                 Iterable<Property> properties,
061                                 Iterable<Location> children ) {
062            super(sourceName, locationInSource, expirationTime, properties);
063            assert children != null;
064            this.children = new LinkedList<Location>();
065            for (Location child : children) {
066                if (child != null) this.children.add(child);
067            }
068            assert this.children.isEmpty() == false;
069            if (ContributionStatistics.RECORD) ContributionStatistics.record(this.properties.size(), this.children.size());
070        }
071    
072        /**
073         * {@inheritDoc}
074         * 
075         * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildren()
076         */
077        @Override
078        public Iterator<Location> getChildren() {
079            return new ImmutableIterator<Location>(children.iterator());
080        }
081    
082        /**
083         * {@inheritDoc}
084         * 
085         * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildrenCount()
086         */
087        @Override
088        public int getChildrenCount() {
089            return children.size();
090        }
091    }