001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors. 
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.connector.federation.contribution;
025    
026    import java.util.HashMap;
027    import java.util.Iterator;
028    import java.util.Map;
029    import net.jcip.annotations.Immutable;
030    import org.jboss.dna.graph.Location;
031    import org.jboss.dna.graph.property.DateTime;
032    import org.jboss.dna.graph.property.Name;
033    import org.jboss.dna.graph.property.Property;
034    
035    /**
036     * The record of a source contributing only properties to a node.
037     * 
038     * @author Randall Hauch
039     */
040    @Immutable
041    public class MultiPropertyContribution extends NonEmptyContribution {
042    
043        /**
044         * This is the first version of this class. See the documentation of MergePlan.serialVersionUID.
045         */
046        private static final long serialVersionUID = 1L;
047    
048        protected final Map<Name, Property> properties;
049    
050        /**
051         * Create a contribution of node properties from the source with the supplied name.
052         * 
053         * @param sourceName the name of the source, which may not be null or blank
054         * @param workspaceName the name of the workspace, which may not be null or blank
055         * @param locationInSource the location in the source for this contributed information; may not be null
056         * @param expirationTime the time (in UTC) after which this contribution should be considered expired, or null if there is no
057         *        expiration time
058         * @param properties the properties from the source; may not be null
059         */
060        public MultiPropertyContribution( String sourceName,
061                                          String workspaceName,
062                                          Location locationInSource,
063                                          DateTime expirationTime,
064                                          Iterable<Property> properties ) {
065            super(sourceName, workspaceName, locationInSource, expirationTime);
066            assert properties != null;
067            this.properties = new HashMap<Name, Property>();
068            for (Property property : properties) {
069                if (property != null) this.properties.put(property.getName(), property);
070            }
071            assert this.properties.isEmpty() == false;
072            if (ContributionStatistics.RECORD) ContributionStatistics.record(this.properties.size(), 0);
073        }
074    
075        /**
076         * {@inheritDoc}
077         * 
078         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperties()
079         */
080        @Override
081        public Iterator<Property> getProperties() {
082            return new ImmutableIterator<Property>(this.properties.values().iterator());
083        }
084    
085        /**
086         * {@inheritDoc}
087         * 
088         * @see org.jboss.dna.connector.federation.contribution.Contribution#getPropertyCount()
089         */
090        @Override
091        public int getPropertyCount() {
092            return this.properties.size();
093        }
094    
095        /**
096         * {@inheritDoc}
097         * 
098         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperty(org.jboss.dna.graph.property.Name)
099         */
100        @Override
101        public Property getProperty( Name name ) {
102            return this.properties.get(name);
103        }
104    }