Package org.topbraidlive.app.framework.api.configuration

Class ImporterConfiguration

java.lang.Object

org.topbraidlive.app.framework.api.configuration.AbstractConfiguration<ImporterConfiguration>

org.topbraidlive.app.framework.api.configuration.ImporterConfiguration

public final class ImporterConfiguration
extends AbstractConfiguration<ImporterConfiguration>

Configuration returned by an app to indicate it exposes an importer.

The fields are public and nullable in order to be compatible with JSON-B.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImporterConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field	Description
String	comment	Optional comment that describes what the importer does.
String	faIcon	Optional FontAwesome icon for the importer, such as "fa-file-excel"
String	id	Required short identifier for the importer.
String	label	Required display label of the importer, such as "Example importer".
List<String>	projectTypes	Required list of project type URIs e.g., "http://teamwork.topbraidlive.org/datagraph/datagraphprojects#ProjectType" for Data Graphs.
String	src	Optional absolute or relative URL to use as the iframe src.

Constructor Summary

Constructors

Constructor	Description
ImporterConfiguration()

Method Summary

Modifier and Type	Method	Description
static ImporterConfiguration.Builder	builder()
boolean	equals(Object o)
int	hashCode()
ImporterConfiguration	validate()	Validate the configuration.

Methods inherited from class org.topbraidlive.app.framework.api.configuration.AbstractConfiguration

validateNotNull, validateStringListNotBlank, validateStringNotBlank

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

comment

public String comment

Optional comment that describes what the importer does. The comment should be HTML attribute value-safe.

faIcon

public String faIcon

Optional FontAwesome icon for the importer, such as "fa-file-excel"

id

public String id

Required short identifier for the importer. Must follow identifier rules ([a-zA-Z_][a-zA-Z0-9_]*).

label

public String label

Required display label of the importer, such as "Example importer".

projectTypes

public List<String> projectTypes

Required list of project type URIs e.g., "http://teamwork.topbraidlive.org/datagraph/datagraphprojects#ProjectType" for Data Graphs.

src

public String src

Optional absolute or relative URL to use as the iframe src. If not specified it will be inferred from the app base URL and the importer id. For an importer "example" on app base URL "http://localhost:8081/app-example", the inferred URL would be "http://localhost:8081/app-example/importer/example". For apps deployed to the same servlet container as the EDG server, it can be useful to specify a relative src such as "/app-example/importer/example". Then the src is independent of the host and port.

Constructor Detail

ImporterConfiguration

public ImporterConfiguration()

Method Detail

builder

public static ImporterConfiguration.Builder builder()

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

validate

public final ImporterConfiguration validate()
                                     throws InvalidConfigurationException

Description copied from class: AbstractConfiguration

Validate the configuration.

Specified by:

validate in class AbstractConfiguration<ImporterConfiguration>

Returns:

this

Throws:

InvalidConfigurationException - if the configuration is invalid