Package org.daisy.dotify.formatter.impl.obfl

Class OBFLExpressionBase

java.lang.Object

org.daisy.dotify.formatter.impl.obfl.OBFLExpressionBase

Direct Known Subclasses:

OBFLCondition, OBFLDynamicContent

public abstract class OBFLExpressionBase
extends Object

TODO: Write java doc. TODO: Remove the defaults from the OBFL specification. See https://github.com/mtmse/obfl/issues/13

Field Summary

Fields

Modifier and Type	Field	Description
protected ExpressionFactory	ef
protected String	exp
static String	PAGE_NUMBER_VARIABLE_NAME
static String	SHEET_COUNT_VARIABLE_NAME
static String	STARTED_PAGE_NUMBER_VARIABLE_NAME
static String	STARTED_VOLUME_FIRST_CONTENT_PAGE_NUMBER_VARIABLE_NAME
static String	STARTED_VOLUME_NUMBER_VARIABLE_NAME
static String	STARTS_AT_TOP_OF_PAGE_VARIABLE_NAME
static String	VOLUME_COUNT_VARIABLE_NAME
static String	VOLUME_NUMBER_VARIABLE_NAME
static String	VOLUME_SHEET_COUNT_VARIABLE_NAME

Constructor Summary

Constructors

Constructor	Description
OBFLExpressionBase(String exp, ExpressionFactory ef, OBFLVariable... variables)

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	buildArgs(Context context)

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_NUMBER_VARIABLE_NAME

public static final String PAGE_NUMBER_VARIABLE_NAME

See Also:

Constant Field Values

VOLUME_NUMBER_VARIABLE_NAME

public static final String VOLUME_NUMBER_VARIABLE_NAME

See Also:

Constant Field Values

VOLUME_COUNT_VARIABLE_NAME

public static final String VOLUME_COUNT_VARIABLE_NAME

See Also:

Constant Field Values

STARTED_VOLUME_NUMBER_VARIABLE_NAME

public static final String STARTED_VOLUME_NUMBER_VARIABLE_NAME

See Also:

Constant Field Values

STARTED_PAGE_NUMBER_VARIABLE_NAME

public static final String STARTED_PAGE_NUMBER_VARIABLE_NAME

See Also:

Constant Field Values

STARTS_AT_TOP_OF_PAGE_VARIABLE_NAME

public static final String STARTS_AT_TOP_OF_PAGE_VARIABLE_NAME

See Also:

Constant Field Values

STARTED_VOLUME_FIRST_CONTENT_PAGE_NUMBER_VARIABLE_NAME

public static final String STARTED_VOLUME_FIRST_CONTENT_PAGE_NUMBER_VARIABLE_NAME

See Also:

Constant Field Values

SHEET_COUNT_VARIABLE_NAME

public static final String SHEET_COUNT_VARIABLE_NAME

See Also:

Constant Field Values

VOLUME_SHEET_COUNT_VARIABLE_NAME

public static final String VOLUME_SHEET_COUNT_VARIABLE_NAME

See Also:

Constant Field Values

ef

protected final ExpressionFactory ef

exp

protected final String exp

Constructor Detail

OBFLExpressionBase

public OBFLExpressionBase(String exp,
                          ExpressionFactory ef,
                          OBFLVariable... variables)

Parameters:

exp - The expression string

ef - The expression factory

variables - The variables (zero or more) that may be used within the expression.

Note that whether a variable will actually be assigned a value is not determined by this object. This depends on the context in which the expression is used.

The variables OBFLVariable.STARTED_PAGE_NUMBER and OBFLVariable.STARTED_VOLUME_FIRST_CONTENT_PAGE_NUMBER cannot both be used in the same expression. At most one "meta" page number is available at any particular place in the OBFL. Which of the two is included in the variables argument does not affect the value that will be assigned, only the variable name. The value is determined by the context.

Method Detail

buildArgs

protected Map<String,String> buildArgs(Context context)