java.lang.Object
- org.topbraidlive.app.framework.api.configuration.AbstractConfiguration<ExporterConfiguration>
- - org.topbraidlive.app.framework.api.configuration.ExporterConfiguration

```
public final class ExporterConfiguration
extends AbstractConfiguration<ExporterConfiguration>
```
Configuration returned by an app to indicate it exposes an exporter.
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 ExporterConfiguration.Builder

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`comment`	Optional comment that describes what the exporter does.
`String`	`faIcon`	Optional FontAwesome icon for the exporter, such as "fa-file-excel"
`String`	`id`	Required short identifier for the exporter.
`boolean`	`inline`	Optional flag that determines whether the exporter should simply be a link on the exporter page (the default) or whether it should open another page in an iframe in order to accept additional parameters from the user.
`String`	`label`	Required display label of the exporter, such as "Example exporter".
`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 href of the exporter link (inline=true exporter) or the src of an iframe (inline=true exporter).

Constructor Summary

Constructors
Constructor Description

ExporterConfiguration()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ExporterConfiguration.Builder`	`builder()`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`ExporterConfiguration`	`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 exporter does. The comment should be HTML attribute value-safe.
  - faIcon
```
public String faIcon
```
    Optional FontAwesome icon for the exporter, such as "fa-file-excel"
  - id
```
public String id
```
    Required short identifier for the exporter. Must follow identifier rules ([a-zA-Z_][a-zA-Z0-9_]*).
  - inline
```
public boolean inline
```
    Optional flag that determines whether the exporter should simply be a link on the exporter page (the default) or whether it should open another page in an iframe in order to accept additional parameters from the user.
  - label
```
public String label
```
    Required display label of the exporter, such as "Example exporter".
  - 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 href of the exporter link (inline=true exporter) or the src of an iframe (inline=true exporter). If not specified it will be inferred from the app base URL and the exporter id. For an exporter "example" on app base URL "http://localhost:8081/app-example", the inferred URL would be "http://localhost:8081/app-example/exporter/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/exporter/example". Then the src is independent of the host and port.
- Constructor Detail
  - ExporterConfiguration
```
public ExporterConfiguration()
```
- Method Detail
  - builder
```
public static ExporterConfiguration.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 ExporterConfiguration validate()
                                     throws InvalidConfigurationException
```
    Description copied from class: AbstractConfiguration
    
    Validate the configuration.
    
    Specified by:
    
    validate in class AbstractConfiguration<ExporterConfiguration>
    
    Returns:
    
    this
    
    Throws:
    
    InvalidConfigurationException - if the configuration is invalid

Class ExporterConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

comment

faIcon

id

inline

label

projectTypes

src

Constructor Detail

ExporterConfiguration

Method Detail

builder

equals

hashCode

validate