Package net.sf.okapi.lib.xliff2.core

Class StartGroupData

java.lang.Object

net.sf.okapi.lib.xliff2.core.InheritedData

net.sf.okapi.lib.xliff2.core.StartGroupData

All Implemented Interfaces:

IWithChangeTrack, IWithExtAttributes, IWithExtElements, IWithInheritedData, IWithMetadata, IWithNotes, IWithValidation

public class StartGroupData
extends InheritedData

Represents the information associated with the start of a group.

Constructor Summary

Constructors

Constructor	Description
StartGroupData(String id)	Creates a new StartGroupData object with a given id.

Method Summary

Modifier and Type	Method	Description
void	addNote(Note note)	Adds a note to the list of notes.
ChangeTrack	getChangeTrack()	Gets the ChangeTrack object for this element, creates an empty of if there is none.
ExtAttributes	getExtAttributes()	Gets the ExtAttributes object for the parent object.
String	getExtAttributeValue(String namespaceURI, String localName)	Gets the value for a given extension attribute.
ExtElements	getExtElements()	Gets the ExtElements object associated with this object.
String	getId()	Gets the id for this object.
Metadata	getMetadata()	Gets the Metadata object for the parent, creates an empty of if there is none.
String	getName()	Gets the name for this group.
int	getNoteCount()	Gets the number of notes for this object.
Notes	getNotes()	Gets the Notes object for this object.
String	getType()	Gets the type for this group.
Validation	getValidation()	Gets the Validation object for the parent, creates an empty of if there is none.
boolean	hasChangeTrack()	Check if there is at least a revision for this element.
boolean	hasExtAttribute()	Indicates if at least one extension attribute is present.
boolean	hasExtElements()	Indicates if there is a ExtElements object associated with this object.
boolean	hasMetadata()	Indicates if the object has metadata.
boolean	hasValidation()	Indicates if the object has validation data.
void	setChangeTrack(ChangeTrack changeTrack)	Sets the ChangeTrack object for this element.
void	setExtAttributes(ExtAttributes attributes)	Sets the ExtAttributes object associated with this object.
ExtElements	setExtElements(ExtElements elements)	Sets the ExtElements object associated with this object.
void	setId(String id)	Sets the id for this object.
void	setMetadata(Metadata metadata)	sets the Metadata object for the parent.
void	setName(String name)	Sets the name for this group.
void	setType(String type)	Sets the type for this group.
void	setValidation(Validation validation)	sets the Validation object for the parent.

Methods inherited from class net.sf.okapi.lib.xliff2.core.InheritedData

getAnnotatorsRef, getCanResegment, getSourceDir, getTargetDir, getTranslate, setAnnotatorsRef, setCanResegment, setInheritableData, setSourceDir, setTargetDir, setTranslate

Methods inherited from class java.lang.Object

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

Constructor Detail

StartGroupData

public StartGroupData(String id)

Creates a new StartGroupData object with a given id.

Parameters:

id - the id to use for this group (should not be null, but allow it to set it later).

Method Detail

getExtElements

public ExtElements getExtElements()

Description copied from interface: IWithExtElements

Gets the ExtElements object associated with this object. If none exists one is created.

Specified by:

getExtElements in interface IWithExtElements

Returns:

the ExtElements object associated with this object. If none exists one is created.

hasExtElements

public boolean hasExtElements()

Description copied from interface: IWithExtElements

Indicates if there is a ExtElements object associated with this object.

Specified by:

hasExtElements in interface IWithExtElements

Returns:

true if there is a ExtElements object associated with this object, false otherwise.

setExtElements

public ExtElements setExtElements(ExtElements elements)

Description copied from interface: IWithExtElements

Sets the ExtElements object associated with this object.

Specified by:

setExtElements in interface IWithExtElements

Parameters:

elements - the ExtElements object associated with this object. If null, a new ExtElements object is created.

Returns:

the ExtElements object associated with this object, never null.

addNote

public void addNote(Note note)

Description copied from interface: IWithNotes

Adds a note to the list of notes.

Specified by:

addNote in interface IWithNotes

Parameters:

note - the note to add.

getNotes

public Notes getNotes()

Description copied from interface: IWithNotes

Gets the Notes object for this object.

Specified by:

getNotes in interface IWithNotes

Returns:

the notes for this object. Never returns null.

getNoteCount

public int getNoteCount()

Description copied from interface: IWithNotes

Gets the number of notes for this object.

Specified by:

getNoteCount in interface IWithNotes

Returns:

the number of notes available.

getName

public String getName()

Gets the name for this group.

Returns:

the name for this group (can be null).

setName

public void setName(String name)

Sets the name for this group.

Parameters:

name - the new name to set (can be null).

getType

public String getType()

Gets the type for this group.

Returns:

the type for this group (can be null).

setType

public void setType(String type)

Sets the type for this group. The value must have a prefix (for both unit and group elements)

Parameters:

type - the new type to set (can be null).

hasMetadata

public boolean hasMetadata()

Description copied from interface: IWithMetadata

Indicates if the object has metadata.

Specified by:

hasMetadata in interface IWithMetadata

Returns:

true if the object has metadata, false otherwise.

getMetadata

public Metadata getMetadata()

Description copied from interface: IWithMetadata

Gets the Metadata object for the parent, creates an empty of if there is none.

Specified by:

getMetadata in interface IWithMetadata

Returns:

the Metadata object for the parent (can be empty, but never null).

setMetadata

public void setMetadata(Metadata metadata)

Description copied from interface: IWithMetadata

sets the Metadata object for the parent.

Specified by:

setMetadata in interface IWithMetadata

Parameters:

metadata - the new Metadata object for the parent.

hasValidation

public boolean hasValidation()

Description copied from interface: IWithValidation

Indicates if the object has validation data.

Specified by:

hasValidation in interface IWithValidation

Returns:

true if the object has validataion data, false otherwise.

getValidation

public Validation getValidation()

Description copied from interface: IWithValidation

Gets the Validation object for the parent, creates an empty of if there is none.

Specified by:

getValidation in interface IWithValidation

Returns:

the Validation object for the parent (can be empty, but never null).

setValidation

public void setValidation(Validation validation)

Description copied from interface: IWithValidation

sets the Validation object for the parent.

Specified by:

setValidation in interface IWithValidation

Parameters:

validation - the new Validation object for the parent.

getChangeTrack

public ChangeTrack getChangeTrack()

Description copied from interface: IWithChangeTrack

Gets the ChangeTrack object for this element, creates an empty of if there is none.

Specified by:

getChangeTrack in interface IWithChangeTrack

Returns:

the ChangeTrack object for this element (can be empty, never null).

setChangeTrack

public void setChangeTrack(ChangeTrack changeTrack)

Description copied from interface: IWithChangeTrack

Sets the ChangeTrack object for this element.

Specified by:

setChangeTrack in interface IWithChangeTrack

Parameters:

changeTrack - the ChangeTrack object for this element.

hasChangeTrack

public boolean hasChangeTrack()

Description copied from interface: IWithChangeTrack

Check if there is at least a revision for this element.

Specified by:

hasChangeTrack in interface IWithChangeTrack

Returns:

true if there is at least a revision for this element; false otherwise.

setId

public void setId(String id)

Sets the id for this object.

Parameters:

id - the id for this object.

getId

public String getId()

Gets the id for this object.

Returns:

the id for this object.

setExtAttributes

public void setExtAttributes(ExtAttributes attributes)

Description copied from interface: IWithExtAttributes

Sets the ExtAttributes object associated with this object.

Specified by:

setExtAttributes in interface IWithExtAttributes

Parameters:

attributes - the ExtAttributes object associated with this object. If null, a new ExtAttributes object is created.

getExtAttributes

public ExtAttributes getExtAttributes()

Description copied from interface: IWithExtAttributes

Gets the ExtAttributes object for the parent object. If none exists, one is created.

Specified by:

getExtAttributes in interface IWithExtAttributes

Returns:

the ExtAttributes object for the parent object, never null.

hasExtAttribute

public boolean hasExtAttribute()

Description copied from interface: IWithExtAttributes

Indicates if at least one extension attribute is present.

Specified by:

hasExtAttribute in interface IWithExtAttributes

Returns:

true if at least one extension attribute is present; false otherwise.

getExtAttributeValue

public String getExtAttributeValue(String namespaceURI,
                                   String localName)

Description copied from interface: IWithExtAttributes

Gets the value for a given extension attribute.

Specified by:

getExtAttributeValue in interface IWithExtAttributes

Parameters:

namespaceURI - the URI of the namespace for the attribute.

localName - the name of the attribute.

Returns:

the value of the extension attribute, or null if it does not exist.