service.tut.pori.contentanalysis

Class VisualShape

java.lang.Object

service.tut.pori.contentanalysis.VisualShape

public class VisualShape
extends java.lang.Object

Defines a visual shape used in combination with a media object.

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shape>
  <shapeType>RECTANGLE</shapeType>
  <value>1194345443,639986100,923810056,69369709</value>
</shape>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VisualShape.VisualShapeSolrCapable Classes implementing this interface will contain functionality for handling an VisualShape.
static class	VisualShape.VisualShapeType Type of the shape object.

Constructor Summary

Constructors

Constructor and Description
VisualShape(VisualShape.VisualShapeType type, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue()
static java.lang.String	getValue(VisualShape shape)
VisualShape.VisualShapeType	getVisualShapeType()
static java.lang.Integer	getVisualShapeTypeId(VisualShape shape)
static boolean	isValid(VisualShape shape)
void	setValue(java.lang.String value)
static VisualShape	setValue(VisualShape shape, java.lang.String value) Sets the given value to the given Shape.
void	setVisualShapeType(VisualShape.VisualShapeType type)
static VisualShape	setVisualShapeTypeId(VisualShape shape, java.lang.Integer value) Sets the given value to the given Shape.

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualShape

public VisualShape(VisualShape.VisualShapeType type,
                   java.lang.String value)

Parameters:

type -

value -

Method Detail

getValue

public java.lang.String getValue()

Returns:

value for the shape. The value differs per shape type.

See Also:

setValue(String), VisualShape.VisualShapeType

setValue

public void setValue(java.lang.String value)

Parameters:

value -

See Also:

getValue()

getVisualShapeType

public VisualShape.VisualShapeType getVisualShapeType()

Returns:

type

See Also:

setVisualShapeType(service.tut.pori.contentanalysis.VisualShape.VisualShapeType)

setVisualShapeType

public void setVisualShapeType(VisualShape.VisualShapeType type)

Parameters:

type -

See Also:

getVisualShapeType()

isValid

public static boolean isValid(VisualShape shape)

Parameters:

shape - can be null

Returns:

true if the passed type is valid

getValue

public static java.lang.String getValue(VisualShape shape)

Parameters:

shape -

Returns:

the value or null if none or the given shape was null

setValue

public static VisualShape setValue(VisualShape shape,
                                   java.lang.String value)

Sets the given value to the given Shape. If shape is null, new shape will be returned (with the value). If value is blank and the given shape is null, null will be returned.

Parameters:

shape - can be null

value -

Returns:

the passed shape, new object or null

getVisualShapeTypeId

public static java.lang.Integer getVisualShapeTypeId(VisualShape shape)

Parameters:

shape -

Returns:

the shape type or null if shape was null or no type given for the shape

setVisualShapeTypeId

public static VisualShape setVisualShapeTypeId(VisualShape shape,
                                               java.lang.Integer value)
                                        throws java.lang.IllegalArgumentException

Sets the given value to the given Shape. If shape is null, new shape will be returned (with the value).

Parameters:

shape - can be null

value -

Returns:

the passed shape, new object or null

Throws:

java.lang.IllegalArgumentException - on bad value