Skip to content
Permalink
Browse files
GIRAPH-1193
GIRAPH-1176

closes #73
  • Loading branch information
dlogothetis committed May 26, 2018
1 parent b2d7741 commit 243a02487237bc5029a10e86665e51ecb20d3cb7
Show file tree
Hide file tree
Showing 21 changed files with 127 additions and 80 deletions.
@@ -29,13 +29,17 @@
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = ElementType.TYPE)
public @interface Algorithm {
// CHECKSTYLE: stop JavadocMethod
/**
* Name of the algorithm.
* @return Name
*/
String name();

/**
* Short description of algorithm which is going to be presented to the user.
* @return Description
*/
String description() default "";
// CHECKSTYLE: resume JavadocMethod
}
@@ -46,6 +46,8 @@ public DoubleDenseMatrixSumAggregator(String name) {
*
* @param numRows the number of rows
* @param master the master to register the aggregators
* @throws InstantiationException
* @throws IllegalAccessException
*/
public void register(int numRows, MasterAggregatorUsage master)
throws InstantiationException, IllegalAccessException {
@@ -46,6 +46,8 @@ public FloatDenseMatrixSumAggregator(String name) {
*
* @param numRows the number of rows
* @param master the master to register the aggregators
* @throws InstantiationException
* @throws IllegalAccessException
*/
public void register(int numRows, MasterAggregatorUsage master)
throws InstantiationException, IllegalAccessException {
@@ -46,6 +46,8 @@ public IntDenseMatrixSumAggregator(String name) {
*
* @param numRows the number of rows
* @param master the master to register the aggregators
* @throws InstantiationException
* @throws IllegalAccessException
*/
public void register(int numRows, MasterAggregatorUsage master)
throws InstantiationException, IllegalAccessException {
@@ -46,6 +46,8 @@ public LongDenseMatrixSumAggregator(String name) {
*
* @param numRows the number of rows
* @param master the master to register the aggregators
* @throws InstantiationException
* @throws IllegalAccessException
*/
public void register(int numRows, MasterAggregatorUsage master)
throws InstantiationException, IllegalAccessException {
@@ -46,6 +46,8 @@ public DoubleSparseMatrixSumAggregator(String name) {
*
* @param numRows the number of rows
* @param master the master to register the aggregators
* @throws InstantiationException
* @throws IllegalAccessException
*/
public void register(int numRows, MasterAggregatorUsage master)
throws InstantiationException, IllegalAccessException {
@@ -151,6 +151,7 @@ void initialize(GraphState graphState,
* @param id Vertex id
* @param value Vertex value
* @param edges Initial edges
* @throws IOException
*/
void addVertexRequest(I id, V value, OutEdges<I, E> edges) throws IOException;

@@ -160,6 +161,7 @@ void initialize(GraphState graphState,
*
* @param id Vertex id
* @param value Vertex value
* @throws IOException
*/
void addVertexRequest(I id, V value) throws IOException;

@@ -168,6 +170,7 @@ void initialize(GraphState graphState,
* (applied just prior to the next superstep).
*
* @param vertexId Id of the vertex to be removed.
* @throws IOException
*/
void removeVertexRequest(I vertexId) throws IOException;

@@ -177,6 +180,7 @@ void initialize(GraphState graphState,
*
* @param sourceVertexId Source vertex id of edge
* @param edge Edge to add
* @throws IOException
*/
void addEdgeRequest(I sourceVertexId, Edge<I, E> edge) throws IOException;

@@ -186,6 +190,7 @@ void initialize(GraphState graphState,
*
* @param sourceVertexId Source vertex id
* @param targetVertexId Target vertex id
* @throws IOException
*/
void removeEdgesRequest(I sourceVertexId, I targetVertexId)
throws IOException;
@@ -34,6 +34,8 @@ public interface MasterAggregatorUsage extends AggregatorUsage {
* @param aggregatorClass Class type of the aggregator
* @param <A> Aggregator type
* @return True iff aggregator wasn't already registered
* @throws InstantiationException
* @throws IllegalAccessException
*/
<A extends Writable> boolean registerAggregator(String name,
Class<? extends Aggregator<A>> aggregatorClass) throws
@@ -48,6 +50,8 @@ <A extends Writable> boolean registerAggregator(String name,
* @param aggregatorClass Class type of the aggregator
* @param <A> Aggregator type
* @return True iff aggregator wasn't already registered
* @throws InstantiationException
* @throws IllegalAccessException
*/
<A extends Writable> boolean registerPersistentAggregator(String name,
Class<? extends Aggregator<A>> aggregatorClass) throws
@@ -69,6 +69,9 @@
/**
* Initialize the MasterCompute class, this is the place to register
* aggregators.
*
* @throws InstantiationException
* @throws IllegalAccessException
*/
public abstract void initialize() throws InstantiationException,
IllegalAccessException;
@@ -149,6 +149,7 @@ public static List<DeployedScript> getScriptsToLoad(Configuration conf) {
* Load all the scripts deployed in Configuration
*
* @param conf Configuration
* @throws IOException
*/
public static void loadScripts(Configuration conf) throws IOException {
List<DeployedScript> deployedScripts = getScriptsToLoad(conf);
@@ -165,6 +166,7 @@ public static void loadScripts(Configuration conf) throws IOException {
*
* @param conf Configuration
* @param deployedScript the deployed script
* @throws IOException
*/
public static void loadScript(Configuration conf,
DeployedScript deployedScript) throws IOException {
@@ -67,7 +67,6 @@ public UnsafeReads(long offset, int length) {
* Check whether there are enough remaining bytes for an operation
*
* @param requiredBytes Bytes required to read
* @throws IOException When there are not enough bytes to read
*/
@Override
protected int require(int requiredBytes) {
@@ -130,6 +130,8 @@ public final void process(WatchedEvent event) {
* Cleans the ZooKeeper quorum of in-memory failed/killed job fragments.
* @param zooKeeper the connected ZK instance (session) to delete from.
* @param zkBasePath the base node to begin erasing from.
* @throws KeeperException
* @throws InterruptedException
*/
public void doZooKeeperCleanup(ZooKeeperExt zooKeeper, String zkBasePath)
throws KeeperException, InterruptedException {
@@ -153,6 +155,7 @@ public void doZooKeeperCleanup(ZooKeeperExt zooKeeper, String zkBasePath)
* @param zkServerList the CSV-style list of hostnames of Zk quorum members.
* @param zkPort the port the quorum is listening on.
* @return the formatted zkConnectList for use in the ZkExt constructor.
* @throws UnknownHostException
*/
private String formatZkServerList(String[] zkServerList, int zkPort)
throws UnknownHostException {
@@ -167,6 +170,7 @@ private String formatZkServerList(String[] zkServerList, int zkPort)

/** Entry point from shell script
* @param args the command line arguments
* @throws Exception
*/
public static void main(String[] args) throws Exception {
System.exit(ToolRunner.run(new GiraphZooKeeperAdmin(), args));
@@ -456,6 +456,8 @@ private void generateZooKeeperConfig() {
/**
* If this task has been selected, online a ZooKeeper server. Otherwise,
* wait until this task knows that the ZooKeeper servers have been onlined.
*
* @throws IOException
*/
public void onlineZooKeeperServer() throws IOException {
if (zkServerTask == taskPartition) {
@@ -80,6 +80,7 @@ public void process(WatchedEvent event) {
/**
* Entry point from shell script
* @param args the command line arguments
* @throws Exception
*/
public static void main(String[] args) throws Exception {
System.exit(ToolRunner.run(new ZooKeeperNodeCreator(), args));
@@ -34,6 +34,7 @@ public interface ZooKeeperRunner extends ImmutableClassesGiraphConfigurable {
* @param zkDir working directory
* @param config zookeeper configuration
* @return port zookeeper runs on
* @throws IOException
*/
int start(String zkDir, ZookeeperConfig config) throws IOException;

@@ -58,9 +58,17 @@ public String getDataLogDir() {
}
return dataLogDir;
}
/** minimum session timeout in milliseconds */
/**
* Minimum session timeout in milliseconds.
* @return Minimum session time.
*/
public int getMinSessionTimeout() { return minSessionTimeout; }
/** maximum session timeout in milliseconds */

/**
* Maximum session timeout in milliseconds.
*
* @return Maximum session time.
*/
public int getMaxSessionTimeout() { return maxSessionTimeout; }

/**
17 pom.xml
@@ -929,6 +929,15 @@ under the License.
<artifactId>cobertura-maven-plugin</artifactId>
<version>2.4</version>
</plugin>
<plugin>
<!-- JXR must be executed beofre Taglist plugin -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
<version>2.3</version>
<configuration>
<aggregate>true</aggregate>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>taglist-maven-plugin</artifactId>
@@ -954,14 +963,6 @@ under the License.
</reportSet>
</reportSets>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
<version>2.3</version>
<configuration>
<aggregate>true</aggregate>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
@@ -30,8 +30,8 @@ under the License.
<section name="Summary">
<p>We build this site with Maven using the fluido plugin. Due to difficulties with the maven site plugin and munge working together, we build the site using a profile that does not require munge.</p>
<ul>
<li>Start at the parent directory and do <source>mvn clean site -DskipTests -Phadoop_2.0.0 -Ddependency.locations.enabled=false</source></li>
<li>Then we need to stage this site since it has multiple modules with <source>mvn site:stage -DskipTests -Phadoop_2.0.0</source></li>
<li>Start at the parent directory and do <source>mvn -Phadoop_2 clean site -DskipTests</source></li>
<li>Then we need to stage this site since it has multiple modules with <source>mvn -Phadoop_2 site:stage -DskipTests</source></li>
<li>You can check the results of the site building and staging in <source>target/staging</source> and then deploy as necessary.</li>
<li>To deploy, check out the site from svn with <source>svn co https://svn.apache.org/repos/asf/giraph/site</source>. Remove everything and then copy the staged site to the directory and then commit. All changes should be live immediately.</li>
</ul>
@@ -37,6 +37,7 @@ under the License.

<subsection name="News">
<ul>
<li><strong>Oct 20, 2016: Giraph 1.2.0 is now released!</strong> Please pick up a copy <a href="http://www.apache.org/dyn/closer.cgi/giraph/giraph-1.2.0">here</a>.</li>
<li><strong>Oct 28, 2015: Practical Graph Analytics with Apache Giraph is now available from Apress.</strong> More details in our books section <a href="literature.html">here</a>.</li>
<li><strong>Nov 19, 2014: Giraph 1.1.0 is now released!</strong> Please pick up a copy <a href="http://www.apache.org/dyn/closer.cgi/giraph/giraph-1.1.0">here</a>.</li>
<li><strong>May 6, 2013: Giraph 1.0.0 is now released!</strong> Please pick up a copy <a href="http://www.apache.org/dyn/closer.cgi/giraph/giraph-1.0.0">here</a>.</li>

0 comments on commit 243a024

Please sign in to comment.