cz.vutbr.web.domassign

Class Variator

java.lang.Object

cz.vutbr.web.domassign.Variator

public abstract class Variator
extends Object

Selects appropriate variant when parsing content of CSS declaration. Allows easy parsing of CSS declaration multi-values such as border: blue 1px

Author:

kapy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Variator.IntegerRef Reference to integer

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ALL_VARIANTS All variants flag
protected List<String>	names Property names according to each variant
protected List<Term<?>>	terms Terms over which variants are tested
protected List<Class<? extends CSSProperty>>	types
protected boolean[]	variantPassed Results of variants.
protected int	variants Total variants available

Constructor Summary

Constructors

Constructor and Description
Variator(int variants) Creates variator which contains variants variants to be tested

Method Summary

Methods

Modifier and Type	Method and Description
void	assignDefaults(Map<String,CSSProperty> properties, Map<String,Term<?>> values) Assigns the default values to all the properties.
void	assignTerms(Term<?>... terms) Assigns terms to be checked by variator
void	assignTermsFromDeclaration(Declaration d) Assigns terms from declaration
void	assignVariantPropertyNames(String... variantPropertyNames) Assigns property names for each variant
protected boolean	checkInherit(int variant, Term<?> term, Map<String,CSSProperty> properties) Solves variant which leads to inherit CSS Property value.
boolean	tryMultiTermVariant(int variant, Map<String,CSSProperty> properties, Map<String,Term<?>> values, Term<?>... terms) Uses variator functionality to test selected variant on more terms.
boolean	tryOneTermVariant(int variant, Declaration d, Map<String,CSSProperty> properties, Map<String,Term<?>> values) Uses variator functionality to test selected variant on term
protected abstract boolean	variant(int variant, Variator.IntegerRef iteration, Map<String,CSSProperty> properties, Map<String,Term<?>> values) This function contains parsing block for variants
protected boolean	variantCondition(int variant, Variator.IntegerRef term) Check if variant, which was passed is able to be located in place where it was found.
boolean	vary(Map<String,CSSProperty> properties, Map<String,Term<?>> values) Test all terms

Methods inherited from class java.lang.Object

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

Field Detail

ALL_VARIANTS

protected static final int ALL_VARIANTS

All variants flag

See Also:

Constant Field Values

variants

protected int variants

Total variants available

variantPassed

protected boolean[] variantPassed

Results of variants. Each variant is allowed to be passed only once in case of multi-value declaration, so this array is used to show that currently passed variant was already successfully passed in past

names

protected List<String> names

Property names according to each variant

types

protected List<Class<? extends CSSProperty>> types

terms

protected List<Term<?>> terms

Terms over which variants are tested

Constructor Detail

Variator

public Variator(int variants)

Creates variator which contains variants variants to be tested

Parameters:

variants -

Method Detail

variant

protected abstract boolean variant(int variant,
              Variator.IntegerRef iteration,
              Map<String,CSSProperty> properties,
              Map<String,Term<?>> values)

This function contains parsing block for variants

Parameters:

variant - Tested variant

iteration - Number of iteration, that is term to be tested. This number may be changed internally in function to inform that more than one term was used for variant

properties - Properties map where to store properties types

values - Values map where to store properties values

Returns:

true in case of success, false otherwise

checkInherit

protected boolean checkInherit(int variant,
                   Term<?> term,
                   Map<String,CSSProperty> properties)

Solves variant which leads to inherit CSS Property value. This overrides all other possible variants and no other informations are allowed per CSS Declaration. This method is called before check for variants or before variant itself is called in one shot way. Example: margin: inherit is valid value and leads to setting of

• margin-top: inherit
• margin-right: inherit
• margin-bottom: inherit
• margin-left: inherit

margin: 0px inherit is invalid value.

Parameters:

variant - Number of variant or identifier of all variants VARIANT_ALL

properties - Properties map where to store properties types

term - Term to be checked

Returns:

true in case of success, false otherwise

variantCondition

protected boolean variantCondition(int variant,
                       Variator.IntegerRef term)

Check if variant, which was passed is able to be located in place where it was found. Example:
We have declaration: font: 12px/14px sans-serif Then according to grammar:

        [ 
                [ <'font-style'> || <'font-variant'> || <'font-weight'> ]? 
                <'font-size'> 
                [ / <'line-height'> ]? 
                <'font-family'> 
  ] 
  | caption | icon | menu | message-box | 
  small-caption | status-bar | inherit
 

1. 12px is assigned to font-size
2. 14px is checked to have SLASH operator before and check to whether font-size was defined before it
3. sans-serif is tested to have at least definition of font-size before itself
4. declaration passes

Parameters:

variant - Identification of current variant which passed test

term - Position in term list of terms which passed test, for multiple value term allow to change it

Returns:

true in case of success, false elsewhere

See Also:

Term.Operator

vary

public boolean vary(Map<String,CSSProperty> properties,
           Map<String,Term<?>> values)

Test all terms

tryOneTermVariant

public boolean tryOneTermVariant(int variant,
                        Declaration d,
                        Map<String,CSSProperty> properties,
                        Map<String,Term<?>> values)

Uses variator functionality to test selected variant on term

Parameters:

variant - Which variant will be tested

d - The declaration on which variant will be tested

properties - Properties map where to store property type

values - Values map where to store property value

Returns:

true in case of success, false otherwise

tryMultiTermVariant

public boolean tryMultiTermVariant(int variant,
                          Map<String,CSSProperty> properties,
                          Map<String,Term<?>> values,
                          Term<?>... terms)

Uses variator functionality to test selected variant on more terms. This is used when variant is represented by more terms. Since usually only one term per variant is used, only one multiple variant is allowed per variator and should be placed as the last one

Parameters:

variant - Number of variant (last variant in variator)

properties - Properties map where to store property type

values - Values map where to store property value

terms - Array of terms used for variant

Returns:

true in case of success, false otherwise

assignVariantPropertyNames

public void assignVariantPropertyNames(String... variantPropertyNames)

Assigns property names for each variant

Parameters:

variantPropertyNames - List of property names

assignTerms

public void assignTerms(Term<?>... terms)

Assigns terms to be checked by variator

Parameters:

terms - Terms to be assigned

assignTermsFromDeclaration

public void assignTermsFromDeclaration(Declaration d)

Assigns terms from declaration

Parameters:

d - Declaration which contains terms

assignDefaults

public void assignDefaults(Map<String,CSSProperty> properties,
                  Map<String,Term<?>> values)

Assigns the default values to all the properties.

Parameters:

properties -

values -