com.xmlmind.xmleditext.profiling

Class AttributeDefinition

java.lang.Object

com.xmlmind.util.PropertySet

com.xmlmind.xmleditext.profiling.AttributeDefinition

All Implemented Interfaces:

Comparable<AttributeDefinition>

public final class AttributeDefinition
extends PropertySet
implements Comparable<AttributeDefinition>

Represent a conditional processing attribute and all the values which are allowed for it (in the context of a ProfileSet).

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeDefinition[]	EMPTY_LIST A ready-to-use empty array of AttributeDefinitions.
Name	name Name of this attribute.
char	separator The character used to separate multiple values.
String[]	styles For each value specified in values, some CSS styles which are added to elements having this attribute with the corresponding value.
String[]	values Allowed values for this attribute.

Fields inherited from class com.xmlmind.util.PropertySet

properties

Constructor Summary

Constructors

Constructor and Description
AttributeDefinition(Name name, String[] values, String[] styles, char separator) Constructs an attribute definition initialized using specified items.

Method Summary

Modifier and Type	Method and Description
boolean	checkValue(String value) Check specified attribute value against this definition.
int	compareTo(AttributeDefinition other)

Methods inherited from class com.xmlmind.util.PropertySet

getProperties, getProperty, getPropertyCount, hasProperty, putProperties, putProperty, removeAllProperties, removeProperty

Methods inherited from class java.lang.Object

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

Field Detail

name

public final Name name

Name of this attribute.

values

public final String[] values

Allowed values for this attribute.

styles

public final String[] styles

For each value specified in values, some CSS styles which are added to elements having this attribute with the corresponding value.

This array has the same size as values, but may contain null elements.

separator

public char separator

The character used to separate multiple values. DocBook example: ";".

Use '\0' to specify that multiple values are not allowed for this attribute.

DocBook example: multiple values separated by ";" are normally allowed. However, for our business case and for attribute security, something like security="public;restricted" does not make sense and should be reported by the XML editor as an error.

EMPTY_LIST

public static final AttributeDefinition[] EMPTY_LIST

A ready-to-use empty array of AttributeDefinitions.

Constructor Detail

AttributeDefinition

public AttributeDefinition(Name name,
                           String[] values,
                           String[] styles,
                           char separator)

Constructs an attribute definition initialized using specified items.

Method Detail

compareTo

public int compareTo(AttributeDefinition other)

Specified by:

compareTo in interface Comparable<AttributeDefinition>

checkValue

public boolean checkValue(String value)

Check specified attribute value against this definition.

Parameters:

value - attribute value to be checked

Returns:

true if the value complies to this defintion; false otherwise