Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api.validators
Class ElementReferenceValidator

    java.lang.Object
      org.eclipse.birt.report.model.validators.AbstractSemanticValidator
          org.eclipse.birt.report.model.validators.AbstractPropertyValidator
              org.eclipse.birt.report.model.api.validators.ElementReferenceValidator

    public class ElementReferenceValidator

extends org.eclipse.birt.report.model.validators.AbstractPropertyValidator

Validates the property whose type is element reference. If the value can refer to an actual element, it will be resolved after validation.

### Rule

The rule is that the element reference value should refer to an actual element in the same report.

### Applicability

This validator is only applied to the element reference properties of `DesignElement`, except `StyledElement.STYLE_PROP`. The `StyledElement.STYLE_PROP` value should be validated with `StyleReferenceValidator`.

Field Summary
`static java.lang.String` | `NAME` Name of this validator.

Fields inherited from class org.eclipse.birt.report.model.validators.AbstractSemanticValidator
`modules, name`

Constructor Summary
`ElementReferenceValidator()`

Method Summary
`static ElementReferenceValidator` | `getInstance()` Returns the singleton validator instance.
`java.util.List` | `validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element, java.lang.String propName)` Validates the element reference value can refer to an actual element.

Methods inherited from class org.eclipse.birt.report.model.validators.AbstractSemanticValidator
`canApplyToDesign, canApplyToLibrary, getName, isTemplateParameterDefinition, setModules, setName`

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

Field Detail

### NAME

    public static final java.lang.String NAME

  Name of this validator.

  See Also:
    Constant Field Values

Constructor Detail

### ElementReferenceValidator

    public ElementReferenceValidator()

Method Detail

### getInstance

    public static ElementReferenceValidator getInstance()

  Returns the singleton validator instance.

  Returns:
    the validator instance

### validate

    public java.util.List validate(org.eclipse.birt.report.model.core.Module module,
                                   org.eclipse.birt.report.model.core.DesignElement element,
                                   java.lang.String propName)

  Validates the element reference value can refer to an actual element.

  Specified by:
    `validate` in class `org.eclipse.birt.report.model.validators.AbstractPropertyValidator`
  Parameters:
    `module` - the module
    `element` - the element holding the element reference property
    `propName` - the name of the element reference property
  Returns:
    error list, each of which is the instance of `SemanticException`.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.