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 java.util.LinkedList;
028 import java.util.List;
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.Property;
033
034 /**
035 * The contribution of a source to the information for a single federated node.
036 *
037 * @author Randall Hauch
038 */
039 @Immutable
040 public class NodeContribution extends MultiPropertyContribution {
041
042 /**
043 * This is the first version of this class. See the documentation of MergePlan.serialVersionUID.
044 */
045 private static final long serialVersionUID = 1L;
046
047 private List<Location> children;
048
049 /**
050 * Create a contribution of node properties and children from the source with the supplied name.
051 *
052 * @param sourceName the name of the source, which may not be null or blank
053 * @param workspaceName the name of the workspace, which may not be null or blank
054 * @param locationInSource the location in the source for this contributed information; may not be null
055 * @param expirationTime the time (in UTC) after which this contribution should be considered expired, or null if there is no
056 * expiration time
057 * @param properties the properties from the source; may not be null
058 * @param children the children from the source; may not be null or empty
059 */
060 public NodeContribution( String sourceName,
061 String workspaceName,
062 Location locationInSource,
063 DateTime expirationTime,
064 Iterable<Property> properties,
065 Iterable<Location> children ) {
066 super(sourceName, workspaceName, locationInSource, expirationTime, properties);
067 assert children != null;
068 this.children = new LinkedList<Location>();
069 for (Location child : children) {
070 if (child != null) this.children.add(child);
071 }
072 assert this.children.isEmpty() == false;
073 if (ContributionStatistics.RECORD) ContributionStatistics.record(this.properties.size(), this.children.size());
074 }
075
076 /**
077 * {@inheritDoc}
078 *
079 * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildren()
080 */
081 @Override
082 public Iterator<Location> getChildren() {
083 return new ImmutableIterator<Location>(children.iterator());
084 }
085
086 /**
087 * {@inheritDoc}
088 *
089 * @see org.jboss.dna.connector.federation.contribution.Contribution#getChildrenCount()
090 */
091 @Override
092 public int getChildrenCount() {
093 return children.size();
094 }
095 }