org.povclipse2.editors

Class Segment

java.lang.Object

org.povclipse2.editors.Segment

public class Segment
extends java.lang.Object

Bean for holding Segment related information like the name, position, type and others.

Author:

Wolfgang Möstl

See Also:

gitweb

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<Segment>	childs
java.lang.String	name
int	numberOfLines
Segment	parent
Position	position
static java.lang.String	PROPERTY_NAME
static java.lang.String	PROPERTY_OCCURRENCE
java.lang.String	type

Constructor Summary

Constructors

Constructor and Description
Segment(java.lang.String name, Position position, java.lang.String type, int numberOfLines) Constructor setting all attributes.
Segment(java.lang.String name, Position position, java.lang.String type, int numberOfLines, java.lang.Boolean expanded) Constructor setting all attributes.

Method Summary

Modifier and Type	Method and Description
void	addChild(Segment child)
Segment	clone(Segment parent) Creates a deep clone of this Segment and it's childs. Please note that the clones Segments share the very same instance of the position and expanded attributes!
boolean	equals(java.lang.Object obj) A segment is considered equal to an other if the following attributs are the very same: position name type
java.util.List<Segment>	getChilds()
int	getEnd()
long	getHash()
int	getLength()
int	getOffset()
Segment	getParent()
long	getSimilarity(Segment other) Indicates how "equal" the given Segment is to this instance.
boolean	hasChilds()
boolean	isExpanded()
void	removeChild(Segment child) Removes a single child from the list of childrens.
void	removeChilds() Removes all childs from the list of children.
void	setExpanded(java.lang.Boolean expanded)
void	setExpandedIncludingChilds(java.lang.Boolean expanded) Collapses ore expands the full sub-tree under the given Segment.
void	setHash(java.lang.String plaintext) Calculates and sets a hash value from the given text.
void	setParent(Segment parent)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME

public static final java.lang.String PROPERTY_NAME

See Also:

Constant Field Values

PROPERTY_OCCURRENCE

public static final java.lang.String PROPERTY_OCCURRENCE

See Also:

Constant Field Values

name

public java.lang.String name

position

public Position position

type

public java.lang.String type

numberOfLines

public int numberOfLines

childs

public java.util.List<Segment> childs

parent

public Segment parent

Constructor Detail

Segment

public Segment(java.lang.String name,
               Position position,
               java.lang.String type,
               int numberOfLines)

Constructor setting all attributes.

Parameters:

name - The Segments name

position - The Segments position

type - The Segment type

numberOfLines - The number of lines within the document.

Segment

public Segment(java.lang.String name,
               Position position,
               java.lang.String type,
               int numberOfLines,
               java.lang.Boolean expanded)

Constructor setting all attributes.

Parameters:

name - The Segments name

position - The Segments position

type - The Segment type

numberOfLines - The number of lines within the document.

expanded - Whether the Segment is expanded or not.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

A human readable information set for this Segement.

getChilds

public java.util.List<Segment> getChilds()

Returns:

The List of child Segment nodes.

addChild

public void addChild(Segment child)

Parameters:

child - The Segement to be added to the child list.

removeChilds

public void removeChilds()

Removes all childs from the list of children.

removeChild

public void removeChild(Segment child)

Removes a single child from the list of childrens. If the child list list does not contain the child, the list is unchanged.

Parameters:

child - The Segment to be removed.

hasChilds

public boolean hasChilds()

Returns:

true if this Segment has at least 1 child, false otherwise.

getParent

public Segment getParent()

Returns:

The parent Segment or null it the Segment has no parent.

setParent

public void setParent(Segment parent)

Parameters:

parent - The parent Segment.

getOffset

public int getOffset()

Returns:

The offset of the position or -1 if no position is set.

getLength

public int getLength()

Returns:

The length of the position or -1 if no position is set.

getEnd

public int getEnd()

Returns:

The position's end index or -1 if no position is set.

equals

public boolean equals(java.lang.Object obj)

A segment is considered equal to an other if the following attributs are the very same:

• position
• name
• type

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

isExpanded

public boolean isExpanded()

Returns:

true if the Segment is expanded, false otherwise.

setExpanded

public void setExpanded(java.lang.Boolean expanded)

Parameters:

expanded - true to indicate that the Segment shall be expanded in the TreeView, false if it shall be collapsed.

setExpandedIncludingChilds

public void setExpandedIncludingChilds(java.lang.Boolean expanded)

Collapses ore expands the full sub-tree under the given Segment.

Parameters:

expanded - true to indicate that the Segment and all it's childs shall be expanded recursively in the TreeView, false if they shall be collapsed.

clone

public Segment clone(Segment parent)

Creates a deep clone of this Segment and it's childs.
Please note that the clones Segments share the very same instance of the position and expanded attributes!

Parameters:

parent - The parent Segment to be used as the clones parent.

Returns:

The cloned Segment.

getHash

public long getHash()

Returns:

The hash value for this Segment.

setHash

public void setHash(java.lang.String plaintext)

Calculates and sets a hash value from the given text.

Parameters:

plaintext - The text to be used to calculate the hash.

getSimilarity

public long getSimilarity(Segment other)

Indicates how "equal" the given Segment is to this instance.

Parameters:

other - The other Segment to be compared with

Returns:

Zero of the Segments can be treated as equal, otherwise a positive integer. The higher the return value the less equal the objects are. If the other Segment is null Long.MAX_VALUE is returned.