fr.univnantes.termsuite.tools

Class CommandLineClient

java.lang.Object

fr.univnantes.termsuite.tools.CommandLineClient

Direct Known Subclasses:

AlignerCLI, PreprocessorCLI, TerminologyExtractorCLI

public abstract class CommandLineClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.util.Set<CliOption>>	atLeastOneOfBags
protected java.util.List<java.util.Set<CliOption>>	atMostOneOfBags
protected ClientHelper	clientHelper
protected java.util.Map<CliOption,java.util.Set<CliOption>>	conditionalAbsentOptions
protected java.util.Map<CliOption,java.util.Set<CliOption>>	conditionalOptions
protected java.util.Set<CliOption>	declaredOptions
protected java.lang.String	description
protected java.util.List<java.util.Set<CliOption>>	exactlyOneOfBags
protected java.util.Set<CliOption>	facultativeOptions
protected org.apache.commons.cli.CommandLine	line
protected java.util.Set<CliOption>	mandatoryOptions
protected org.apache.commons.cli.Options	options

Constructor Summary

Constructors

Constructor and Description
CommandLineClient(java.lang.String description)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	asArray(CliOption opt)
boolean	asBoolean(CliOption opt)
java.lang.Class<?>	asClass(CliOption opt)
java.nio.file.Path	asDir(CliOption opt)
double	asDouble(CliOption opt)
protected IndexedCorpus	asIndexedCorpus(CliOption path)
int	asInt(CliOption opt)
java.util.List<java.lang.String>	asList(CliOption opt)
long	asLong(CliOption opt)
java.nio.file.Path	asPath(CliOption opt)
Property<?>	asProperty(CliOption opt)
Property<?>	asProperty(java.lang.String propertyName)
RelationProperty	asRelationProperty(CliOption opt)
java.lang.String	asString(CliOption opt)
TermProperty	asTermProperty(CliOption opt)
TermProperty	asTermProperty(java.lang.String pName)
java.util.List<java.lang.String>	asTermString(CliOption opt)
void	checkAtLeastOneOf()
void	checkAtMostOneOf()
void	checkClientState(CliOption opt)
void	checkExactlyOneOf()
abstract void	configureOpts()
void	declareAtLeastOneOf(CliOption first, CliOption second, CliOption... others)
void	declareAtMostOneOf(CliOption first, CliOption second, CliOption... others)
void	declareCannotAppearWhenCondition(CliOption conditionalOpt, CliOption... mustBeAbsentOnCondition) Declares a list of options that cannot appear when a conditional option is set.
void	declareConditional(CliOption conditionalOpt, CliOption... mandatoryOptsIfPresent) Declare some option mandatory only when another facultative (optional) option is present.
void	declareExactlyOneOf(CliOption first, CliOption second, CliOption... others)
void	declareFacultative(CliOption option)
void	declareMandatory(CliOption option)
void	doHelp(java.io.PrintStream out)
Lang	getLang()
java.util.List<java.lang.String>	getList(CliOption opt)
java.util.Optional<java.lang.String>	getOpt(CliOption opt)
boolean	hasOpt(CliOption opt)
boolean	isSet(CliOption opt)
void	launch(java.lang.String... args)
protected abstract void	run()
protected void	runClient(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

clientHelper

protected ClientHelper clientHelper

description

protected java.lang.String description

options

protected org.apache.commons.cli.Options options

line

protected org.apache.commons.cli.CommandLine line

atLeastOneOfBags

protected java.util.List<java.util.Set<CliOption>> atLeastOneOfBags

atMostOneOfBags

protected java.util.List<java.util.Set<CliOption>> atMostOneOfBags

exactlyOneOfBags

protected java.util.List<java.util.Set<CliOption>> exactlyOneOfBags

declaredOptions

protected java.util.Set<CliOption> declaredOptions

facultativeOptions

protected java.util.Set<CliOption> facultativeOptions

mandatoryOptions

protected java.util.Set<CliOption> mandatoryOptions

conditionalOptions

protected java.util.Map<CliOption,java.util.Set<CliOption>> conditionalOptions

conditionalAbsentOptions

protected java.util.Map<CliOption,java.util.Set<CliOption>> conditionalAbsentOptions

Constructor Detail

CommandLineClient

public CommandLineClient(java.lang.String description)

Method Detail

configureOpts

public abstract void configureOpts()

run

protected abstract void run()
                     throws java.lang.Exception

Throws:

java.lang.Exception

declareAtMostOneOf

public void declareAtMostOneOf(CliOption first,
                               CliOption second,
                               CliOption... others)

declareAtLeastOneOf

public void declareAtLeastOneOf(CliOption first,
                                CliOption second,
                                CliOption... others)

declareExactlyOneOf

public void declareExactlyOneOf(CliOption first,
                                CliOption second,
                                CliOption... others)

declareMandatory

public void declareMandatory(CliOption option)

declareConditional

public void declareConditional(CliOption conditionalOpt,
                               CliOption... mandatoryOptsIfPresent)

Declare some option mandatory only when another facultative (optional) option is present.

Parameters:

conditionalOpt -

mandatoryOptsIfPresent -

declareCannotAppearWhenCondition

public void declareCannotAppearWhenCondition(CliOption conditionalOpt,
                                             CliOption... mustBeAbsentOnCondition)

Declares a list of options that cannot appear when a conditional option is set.

Parameters:

conditionalOpt -

mustBeAbsentOnCondition -

declareFacultative

public void declareFacultative(CliOption option)

getOpt

public java.util.Optional<java.lang.String> getOpt(CliOption opt)

hasOpt

public boolean hasOpt(CliOption opt)

checkClientState

public void checkClientState(CliOption opt)

asPath

public java.nio.file.Path asPath(CliOption opt)

asIndexedCorpus

protected IndexedCorpus asIndexedCorpus(CliOption path)

asDir

public java.nio.file.Path asDir(CliOption opt)

asBoolean

public boolean asBoolean(CliOption opt)

asInt

public int asInt(CliOption opt)

getList

public java.util.List<java.lang.String> getList(CliOption opt)

isSet

public boolean isSet(CliOption opt)

asLong

public long asLong(CliOption opt)

asList

public java.util.List<java.lang.String> asList(CliOption opt)

asArray

public java.lang.String[] asArray(CliOption opt)

asString

public java.lang.String asString(CliOption opt)

asTermString

public java.util.List<java.lang.String> asTermString(CliOption opt)

getLang

public Lang getLang()

asDouble

public double asDouble(CliOption opt)

launch

public void launch(java.lang.String... args)

runClient

protected void runClient(java.lang.String[] args)

doHelp

public void doHelp(java.io.PrintStream out)

checkExactlyOneOf

public void checkExactlyOneOf()

checkAtMostOneOf

public void checkAtMostOneOf()

checkAtLeastOneOf

public void checkAtLeastOneOf()

asProperty

public Property<?> asProperty(CliOption opt)

asProperty

public Property<?> asProperty(java.lang.String propertyName)

asTermProperty

public TermProperty asTermProperty(java.lang.String pName)

asTermProperty

public TermProperty asTermProperty(CliOption opt)

asRelationProperty

public RelationProperty asRelationProperty(CliOption opt)

asClass

public java.lang.Class<?> asClass(CliOption opt)