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