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.Iterator;
027    import net.jcip.annotations.Immutable;
028    import org.jboss.dna.graph.Location;
029    import org.jboss.dna.graph.property.DateTime;
030    import org.jboss.dna.graph.property.Name;
031    import org.jboss.dna.graph.property.Property;
032    
033    /**
034     * The record of a source contributing only properties to a node.
035     * 
036     * @author Randall Hauch
037     */
038    @Immutable
039    public class ThreePropertyContribution extends NonEmptyContribution {
040    
041        /**
042         * This is the first version of this class. See the documentation of MergePlan.serialVersionUID.
043         */
044        private static final long serialVersionUID = 1L;
045    
046        private final Property property1;
047        private final Property property2;
048        private final Property property3;
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 property1 the first property from the source; may not be null
059         * @param property2 the second property from the source; may not be null
060         * @param property3 the third property from the source; may not be null
061         */
062        public ThreePropertyContribution( String sourceName,
063                                          String workspaceName,
064                                          Location locationInSource,
065                                          DateTime expirationTime,
066                                          Property property1,
067                                          Property property2,
068                                          Property property3 ) {
069            super(sourceName, workspaceName, locationInSource, expirationTime);
070            assert property1 != null;
071            assert property1.isEmpty() == false;
072            assert property2 != null;
073            assert property2.isEmpty() == false;
074            assert property3 != null;
075            assert property3.isEmpty() == false;
076            this.property1 = property1;
077            this.property2 = property2;
078            this.property3 = property3;
079            if (ContributionStatistics.RECORD) ContributionStatistics.record(3, 0);
080        }
081    
082        /**
083         * {@inheritDoc}
084         * 
085         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperties()
086         */
087        @Override
088        public Iterator<Property> getProperties() {
089            return new ThreeValueIterator<Property>(property1, property2, property3);
090        }
091    
092        /**
093         * {@inheritDoc}
094         * 
095         * @see org.jboss.dna.connector.federation.contribution.Contribution#getPropertyCount()
096         */
097        @Override
098        public int getPropertyCount() {
099            return 3;
100        }
101    
102        /**
103         * {@inheritDoc}
104         * 
105         * @see org.jboss.dna.connector.federation.contribution.Contribution#getProperty(org.jboss.dna.graph.property.Name)
106         */
107        @Override
108        public Property getProperty( Name name ) {
109            if (this.property1.getName().equals(name)) return property1;
110            if (this.property2.getName().equals(name)) return property2;
111            if (this.property3.getName().equals(name)) return property3;
112            return null;
113        }
114    
115    }