SciJava

https://scijava.org
Admin
SciJava is a collaboration of Java libraries and applications for scientific computing, providing...
Tokens:1,366
Snippets:25
Trust Score:8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Initialize SciJava Context and Get Services

Source: https://scijava.org/scijava-common/scijava-common.html

Creates a SciJava Context and retrieves a service, such as the PluginService, from it.

```java
final Context context = new Context();

final PluginService pluginService = context.getService(PluginService.class);


```

--------------------------------

### Utility Function for File Operations

Source: https://scijava.org/scijava-common/scijava-common.html

Example of using utility functions for file operations, such as listing directory contents recursively.

```java
// list all files in the class path entry as org/scijava/Context.class
final URL location = ClassUtils.getLocation(Context.class);
for (final URL url : FileUtils.listContents(location)) {
	// ...
}


```

--------------------------------

### Discover and Run Plugins using PluginService

Source: https://scijava.org/scijava-common/scijava-common.html

Demonstrates how to use the PluginService to find and instantiate plugins of a specific type, then invoke their methods.

```java
PluginService pluginService;

List<HelloPlugin> plugins = 
	pluginService.createInstancesOfType(HelloPlugin.class);
for (final HelloPlugin hello : plugins) {
	hello.sayHello();
}


```

--------------------------------

### Implement a Default Service with Dependencies

Source: https://scijava.org/scijava-common/scijava-common.html

Provides a default implementation for a service, demonstrating dependency injection using the @Parameter annotation.

```java
@Plugin(type = Service.class)
public class DefaultHelloService implements HelloService {
	@Parameter
	private StatusService status;

	@Override
	public void initialize() {
	        // initialize as little as possible here
	}

	@Override
	public void sayHello() {
	        status.showStatus("Howdy!");
	}
}


```

--------------------------------

### Implement an Overriding Service with Higher Priority

Source: https://scijava.org/scijava-common/scijava-common.html

Shows how to provide an alternative implementation for a service, using a higher priority to ensure it's chosen over the default.

```java
@Plugin(type = Service.class, priority = Priority.HIGH_PRIORITY)
public class SilentHelloService implements HelloService {
	@Override
	public void sayHello() {
	        // Shhhh!
	}
}


```

--------------------------------

### Define a Custom Plugin Interface and Implementation

Source: https://scijava.org/scijava-common/scijava-common.html

Shows how to define a custom plugin interface extending SciJavaPlugin and a concrete implementation.

```java
public interface HelloPlugin extends SciJavaPlugin {
	public void sayHello();
}

@Plugin(type = HelloPlugin.class)
public class HelloKNIME implements HelloPlugin {
	@Override
	public void sayHello() {
	        System.out.println("Hello!");
	}
}


```

--------------------------------

### Define a Simple Plugin

Source: https://scijava.org/scijava-common/scijava-common.html

Defines a basic plugin implementing the Command interface. The @Plugin annotation is used for discovery.

```java
@Plugin(type = Command.class)
public class HelloWorld implements Command {
	@Override
	public void run() {
	        // ...
	}
}
						
```

--------------------------------

### Execute Commands with CommandService

Source: https://scijava.org/scijava-common/scijava-common.html

Uses CommandService to run a command class, optionally providing parameter overrides.

```java
@Parameter
private CommandService commands;

...
	boolean fillUnsetParameters = true;
	commands.run(HelloWorld.class, fillUnsetParameters,
				"name", "Bugs Bunny");
```

--------------------------------

### Define an ImageJ2 Command

Source: https://scijava.org/scijava-common/scijava-common.html

Implements the Command interface with @Plugin and @Parameter annotations to define inputs and outputs.

```java
@Plugin(type = Command.class, headless = true,
	menuPath = "Help>Hello, World!")
public class HelloWorld implements Command {
	@Parameter(label = "What is your name?")
	private String name = "J. Doe";

	@Parameter(type = ItemIO.OUTPUT)
	private String greeting;

	@Override
	public void run() {
					greeting = "Hello, " + name + "!";
	}
}
```

--------------------------------

### Define a Service Interface

Source: https://scijava.org/scijava-common/scijava-common.html

Defines a service interface that extends the SciJavaService marker interface.

```java
public interface HelloService extends SciJavaService {
	public void sayHello();
}


```
Tokens:
Raw