java.lang.Object
- fr.mines_stetienne.ci.sparql_generate.cli.CMDConfigurations

public class CMDConfigurations
extends Object

Author:: Maxime Lefrançois

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ARG_BASE`	b
`static String`	`ARG_BASE_LONG`	base
`static String`	`ARG_BASE_MAN`	Base URI of the working directory.
`static String`	`ARG_BIND_LONG`	bind
`static String`	`ARG_BIND_MAN`	Binds a query parameter to a RDF term
`static String`	`ARG_DEBUG_TEMPLATE`	dt
`static String`	`ARG_DEBUG_TEMPLATE_LONG`	debug-template
`static String`	`ARG_DEBUG_TEMPLATE_MAN`	Debug the template output: insert warning identifiers that refer to the log.
`static String`	`ARG_DIRECTORY`	d
`static String`	`ARG_DIRECTORY_DEFAULT`	.
`static String`	`ARG_DIRECTORY_LONG`	dir
`static String`	`ARG_DIRECTORY_MAN`	Location of the directory with the queryset, documentset, dataset, and configuration files as explained in https://w3id.org/sparql-generate/language-cli.html.
`static String`	`ARG_HDT`	hdt
`static String`	`ARG_HDT_LONG`	hdt
`static String`	`ARG_HDT_MAN`	Generate output as HDT.
`static String`	`ARG_HELP`	h
`static String`	`ARG_HELP_LONG`	help
`static String`	`ARG_HELP_MAN`	Show help
`static String`	`ARG_LOG_FILE`	f
`static String`	`ARG_LOG_FILE_LONG`	log-file
`static String`	`ARG_LOG_FILE_MAN`	Location where the log is to be stored.
`static String`	`ARG_LOG_LEVEL`	l
`static String`	`ARG_LOG_LEVEL_LONG`	log-level
`static String`	`ARG_LOG_LEVEL_MAN`	Set log level, acceptable values are TRACE < DEBUG < INFO < WARN < ERROR < OFF.
`static String`	`ARG_OUTPUT`	o
`static String`	`ARG_OUTPUT_APPEND`	oa
`static String`	`ARG_OUTPUT_APPEND_LONG`	output-append
`static String`	`ARG_OUTPUT_APPEND_MAN`	Write from the end of the output file, instead of replacing it.
`static String`	`ARG_OUTPUT_FORMAT`	of
`static String`	`ARG_OUTPUT_FORMAT_LONG`	output-format
`static String`	`ARG_OUTPUT_FORMAT_MAN`	Format of the output file, e.g.
`static String`	`ARG_OUTPUT_LONG`	output
`static String`	`ARG_OUTPUT_MAN`	Location where the output is to be stored.
`static String`	`ARG_QUERY`	q
`static String`	`ARG_QUERY_LONG`	query-file
`static String`	`ARG_QUERY_MAN`	Name of the query file in the directory.
`static String`	`ARG_SOURCE_LONG`	Deprecated.
`static String`	`ARG_SOURCE_MAN`	Deprecated.
`static String`	`ARG_STREAM`	s
`static String`	`ARG_STREAM_LONG`	stream
`static String`	`ARG_STREAM_MAN`	Generate output as stream.
`static String`	`ARG_SYNTAX`	x
`static String`	`ARG_SYNTAX_LONG`	syntax
`static String`	`ARG_SYNTAX_MAN`	Just validate the query, do nothing else

Constructor Summary

Constructors
Constructor Description

CMDConfigurations()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`displayHelp()`
`static org.apache.commons.cli.Options`	`getCMDOptions()`
`static org.apache.commons.cli.CommandLine`	`parseArguments(String[] args)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ARG_HELP
```
public static final String ARG_HELP
```
    h
    
    See Also:
    
    Constant Field Values
  - ARG_HELP_LONG
```
public static final String ARG_HELP_LONG
```
    help
    
    See Also:
    
    Constant Field Values
  - ARG_HELP_MAN
```
public static final String ARG_HELP_MAN
```
    Show help
    
    See Also:
    
    Constant Field Values
  - ARG_DIRECTORY
```
public static final String ARG_DIRECTORY
```
    d
    
    See Also:
    
    Constant Field Values
  - ARG_DIRECTORY_LONG
```
public static final String ARG_DIRECTORY_LONG
```
    dir
    
    See Also:
    
    Constant Field Values
  - ARG_DIRECTORY_DEFAULT
```
public static final String ARG_DIRECTORY_DEFAULT
```
    .
    
    See Also:
    
    Constant Field Values
  - ARG_DIRECTORY_MAN
```
public static final String ARG_DIRECTORY_MAN
```
    Location of the directory with the queryset, documentset, dataset, and configuration files as explained in https://w3id.org/sparql-generate/language-cli.html. Default value is . (the current folder)
    
    See Also:
    
    Constant Field Values
  - ARG_BASE
```
public static final String ARG_BASE
```
    b
    
    See Also:
    
    Constant Field Values
  - ARG_BASE_LONG
```
public static final String ARG_BASE_LONG
```
    base
    
    See Also:
    
    Constant Field Values
  - ARG_BASE_MAN
```
public static final String ARG_BASE_MAN
```
    Base URI of the working directory. If set, each file in the working directory is identified by a URI resolved against the base.
    
    See Also:
    
    Constant Field Values
  - ARG_QUERY
```
public static final String ARG_QUERY
```
    q
    
    See Also:
    
    Constant Field Values
  - ARG_QUERY_LONG
```
public static final String ARG_QUERY_LONG
```
    query-file
    
    See Also:
    
    Constant Field Values
  - ARG_QUERY_MAN
```
public static final String ARG_QUERY_MAN
```
    Name of the query file in the directory. Default value is ./query.rqg
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT
```
public static final String ARG_OUTPUT
```
    o
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT_LONG
```
public static final String ARG_OUTPUT_LONG
```
    output
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT_MAN
```
public static final String ARG_OUTPUT_MAN
```
    Location where the output is to be stored. By default the output is stored in a file with the same name as the query and the extension '.out'.
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT_APPEND
```
public static final String ARG_OUTPUT_APPEND
```
    oa
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT_APPEND_LONG
```
public static final String ARG_OUTPUT_APPEND_LONG
```
    output-append
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT_APPEND_MAN
```
public static final String ARG_OUTPUT_APPEND_MAN
```
    Write from the end of the output file, instead of replacing it.
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT_FORMAT
```
public static final String ARG_OUTPUT_FORMAT
```
    of
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT_FORMAT_LONG
```
public static final String ARG_OUTPUT_FORMAT_LONG
```
    output-format
    
    See Also:
    
    Constant Field Values
  - ARG_OUTPUT_FORMAT_MAN
```
public static final String ARG_OUTPUT_FORMAT_MAN
```
    Format of the output file, e.g. TTL, NT, etc. for GENERATE, or TEXT, XML, CSV, etc. for SELECT.
    
    See Also:
    
    Constant Field Values
  - ARG_SOURCE_LONG
```
@Deprecated
public static final String ARG_SOURCE_LONG
```
    Deprecated.
    
    source
    
    See Also:
    
    Constant Field Values
  - ARG_SOURCE_MAN
```
@Deprecated
public static final String ARG_SOURCE_MAN
```
    Deprecated.
    
    Replaces in a SOURCE clause with the given value, e.g. urn:sg:source=source.json.
    
    See Also:
    
    Constant Field Values
  - ARG_STREAM
```
public static final String ARG_STREAM
```
    s
    
    See Also:
    
    Constant Field Values
  - ARG_STREAM_LONG
```
public static final String ARG_STREAM_LONG
```
    stream
    
    See Also:
    
    Constant Field Values
  - ARG_STREAM_MAN
```
public static final String ARG_STREAM_MAN
```
    Generate output as stream.
    
    See Also:
    
    Constant Field Values
  - ARG_HDT
```
public static final String ARG_HDT
```
    hdt
    
    See Also:
    
    Constant Field Values
  - ARG_HDT_LONG
```
public static final String ARG_HDT_LONG
```
    hdt
    
    See Also:
    
    Constant Field Values
  - ARG_HDT_MAN
```
public static final String ARG_HDT_MAN
```
    Generate output as HDT.
    
    See Also:
    
    Constant Field Values
  - ARG_LOG_LEVEL
```
public static final String ARG_LOG_LEVEL
```
    l
    
    See Also:
    
    Constant Field Values
  - ARG_LOG_LEVEL_LONG
```
public static final String ARG_LOG_LEVEL_LONG
```
    log-level
    
    See Also:
    
    Constant Field Values
  - ARG_LOG_LEVEL_MAN
```
public static final String ARG_LOG_LEVEL_MAN
```
    Set log level, acceptable values are TRACE < DEBUG < INFO < WARN < ERROR < OFF. No value or unrecognized value results in level DEBUG
    
    See Also:
    
    Constant Field Values
  - ARG_LOG_FILE
```
public static final String ARG_LOG_FILE
```
    f
    
    See Also:
    
    Constant Field Values
  - ARG_LOG_FILE_LONG
```
public static final String ARG_LOG_FILE_LONG
```
    log-file
    
    See Also:
    
    Constant Field Values
  - ARG_LOG_FILE_MAN
```
public static final String ARG_LOG_FILE_MAN
```
    Location where the log is to be stored. Log also goes to the console.
    
    See Also:
    
    Constant Field Values
  - ARG_DEBUG_TEMPLATE
```
public static final String ARG_DEBUG_TEMPLATE
```
    dt
    
    See Also:
    
    Constant Field Values
  - ARG_DEBUG_TEMPLATE_LONG
```
public static final String ARG_DEBUG_TEMPLATE_LONG
```
    debug-template
    
    See Also:
    
    Constant Field Values
  - ARG_DEBUG_TEMPLATE_MAN
```
public static final String ARG_DEBUG_TEMPLATE_MAN
```
    Debug the template output: insert warning identifiers that refer to the log.
    
    See Also:
    
    Constant Field Values
  - ARG_BIND_LONG
```
public static final String ARG_BIND_LONG
```
    bind
    
    See Also:
    
    Constant Field Values
  - ARG_BIND_MAN
```
public static final String ARG_BIND_MAN
```
    Binds a query parameter to a RDF term
    
    See Also:
    
    Constant Field Values
  - ARG_SYNTAX
```
public static final String ARG_SYNTAX
```
    x
    
    See Also:
    
    Constant Field Values
  - ARG_SYNTAX_LONG
```
public static final String ARG_SYNTAX_LONG
```
    syntax
    
    See Also:
    
    Constant Field Values
  - ARG_SYNTAX_MAN
```
public static final String ARG_SYNTAX_MAN
```
    Just validate the query, do nothing else
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CMDConfigurations
```
public CMDConfigurations()
```
- Method Detail
  - parseArguments
```
public static org.apache.commons.cli.CommandLine parseArguments(String[] args)
                                                         throws org.apache.commons.cli.ParseException
```
    Throws:
    
    org.apache.commons.cli.ParseException
  - getCMDOptions
```
public static org.apache.commons.cli.Options getCMDOptions()
```
  - displayHelp
```
public static void displayHelp()
```

Class CMDConfigurations

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ARG_HELP

ARG_HELP_LONG

ARG_HELP_MAN

ARG_DIRECTORY

ARG_DIRECTORY_LONG

ARG_DIRECTORY_DEFAULT

ARG_DIRECTORY_MAN

ARG_BASE

ARG_BASE_LONG

ARG_BASE_MAN

ARG_QUERY

ARG_QUERY_LONG

ARG_QUERY_MAN

ARG_OUTPUT

ARG_OUTPUT_LONG

ARG_OUTPUT_MAN

ARG_OUTPUT_APPEND

ARG_OUTPUT_APPEND_LONG

ARG_OUTPUT_APPEND_MAN

ARG_OUTPUT_FORMAT

ARG_OUTPUT_FORMAT_LONG

ARG_OUTPUT_FORMAT_MAN

ARG_SOURCE_LONG

ARG_SOURCE_MAN

ARG_STREAM

ARG_STREAM_LONG

ARG_STREAM_MAN

ARG_HDT

ARG_HDT_LONG

ARG_HDT_MAN

ARG_LOG_LEVEL

ARG_LOG_LEVEL_LONG

ARG_LOG_LEVEL_MAN

ARG_LOG_FILE

ARG_LOG_FILE_LONG

ARG_LOG_FILE_MAN

ARG_DEBUG_TEMPLATE

ARG_DEBUG_TEMPLATE_LONG

ARG_DEBUG_TEMPLATE_MAN

ARG_BIND_LONG

ARG_BIND_MAN

ARG_SYNTAX

ARG_SYNTAX_LONG

ARG_SYNTAX_MAN

Constructor Detail

CMDConfigurations

Method Detail

parseArguments

getCMDOptions

displayHelp