viper.descriptors.attributes
Class Attribute_obox

java.lang.Object
  viper.descriptors.attributes.AbstractAttribute
      viper.descriptors.attributes.Attribute
          viper.descriptors.attributes.Attribute_polygon
              viper.descriptors.attributes.Attribute_obox

All Implemented Interfaces:

java.lang.Cloneable, Filterable

public class Attribute_obox

extends Attribute_polygon

implements java.lang.Cloneable

This attribute represents a rotated recatangle or Oriented Box.

Nested Class Summary

protected static class	Attribute_obox.Obox
protected static class	Attribute_obox.Resizer Adds to the boxes size.

Nested classes inherited from class viper.descriptors.attributes.Attribute_polygon

Attribute_polygon.Sizer

Nested classes inherited from class viper.filters.Filterable

Filterable.Rule

Field Summary

Fields inherited from class viper.descriptors.attributes.Attribute

composition, compositionTolerance, compositionType, errors, value

Constructor Summary

Attribute_obox()
Constructs an empty static obox-valued attribute.

Attribute_obox(Attribute old)
Copies the old attribute.

Attribute_obox(boolean dynamic)
Attributes for OBJECT type should use this constructor, with dynamic set to true.

Method Summary

java.lang.Object	clone() Returns a clone of this Attribute.
Filterable.Rule	convertRule(java.lang.String unparsedRule, java.util.List unparsedValues, ErrorWriter err) This converts a string into a rule, writing out errors in the format to err.
java.lang.String	getType() Returns the Attribute type, eg lvalue or bbox.
boolean	isValidRule(java.lang.String ruleName) Tell if a name is a valid rule or not
boolean	possibleValueOf(java.lang.String S) Determines if this Attribute can take the value specified.

Methods inherited from class viper.descriptors.attributes.Attribute_polygon

getArea, getAreaOfIntersectionWith, setArchetype, setArchetype

Methods inherited from class viper.descriptors.attributes.Attribute

compareTo, compose, crop, getCompositionType, getExtraConfig, getStaticValue, getValue, getValues, getValueToString, getXMLFormat, getXMLFormat, isCompositionType, isType, nullXML, nullXML, parseExtraConfig, passes, possibleValueOf, setCompositionType, setDefaultValue, setDefaultValue, setExtraConfig, setFrameSpan, setName, setOutputWidth, setStaticValue, setValue, setValue, setValue, setValue, setValue, toString

Methods inherited from class viper.descriptors.attributes.AbstractAttribute

getArchetype, getDefault, getExtraConfigInXML, getExtraConfigString, getName, isDynamic, loadAttributeType, named, named, parseAnInt, resetDefault, setArchetype, setDynamic

Methods inherited from class java.lang.Object

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

Constructor Detail

Attribute_obox

public Attribute_obox()

Constructs an empty static obox-valued attribute.

Attribute_obox

public Attribute_obox(boolean dynamic)

Attributes for OBJECT type should use this constructor, with dynamic set to true.

Parameters:

dynamic - Descriptor that holds this Attribute is of type OBJECT

Attribute_obox

public Attribute_obox(Attribute old)

Copies the old attribute.

Parameters:

old - the attribute to copy

Method Detail

getType

public java.lang.String getType()

Description copied from class: AbstractAttribute

Returns the Attribute type, eg lvalue or bbox.

Overrides:

getType in class Attribute_polygon

Returns:

"obox"

clone

public java.lang.Object clone()

Returns a clone of this Attribute.

Overrides:

clone in class Attribute_polygon

Returns:

a reference to a new Attribute with all the values of the original

possibleValueOf

public boolean possibleValueOf(java.lang.String S)

Description copied from class: Attribute

Determines if this Attribute can take the value specified. Relations are not yet supported.

Overrides:

possibleValueOf in class Attribute

Parameters:

S - the string to be tested

Returns:

whether or not the string is valid

isValidRule

public boolean isValidRule(java.lang.String ruleName)

Description copied from interface: Filterable

Tell if a name is a valid rule or not

Specified by:

isValidRule in interface Filterable

Overrides:

isValidRule in class Attribute_polygon

convertRule

public Filterable.Rule convertRule(java.lang.String unparsedRule,
                                   java.util.List unparsedValues,
                                   ErrorWriter err)
                            throws BadDataException

Description copied from class: Attribute_polygon

This converts a string into a rule, writing out errors in the format to err.

Specified by:

convertRule in interface Filterable

Overrides:

convertRule in class Attribute_polygon

Parameters:

unparsedRule - A string containing a single rule.

unparsedValues - A string containing values.

err - A place to log the errors.

Returns:

A List containing a rule (String) and value (Object) pair.

Throws:

BadDataException