org.obolibrary.oboformat.model

Class Frame

java.lang.Object

org.obolibrary.oboformat.model.Frame

public class Frame
extends Object

The Class Frame.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Frame.FrameType The Enum FrameType.

Constructor Summary

Constructors

Constructor and Description
Frame() Instantiates a new frame.
Frame(Frame.FrameType type) Instantiates a new frame.

Method Summary

Modifier and Type	Method and Description
void	addClause(Clause cl)
void	check() Check this frame for violations, i.e.
void	freeze() freezing a frame signals that a frame has become quiescent, and that data structures can be adjusted to increase performance or reduce memory consumption.
Clause	getClause(OBOFormatConstants.OboFormatTag tag)
Clause	getClause(String tag)
Collection<Clause>	getClauses()
List<Clause>	getClauses(OBOFormatConstants.OboFormatTag tag)
List<Clause>	getClauses(String tag)
String	getId()
Set<String>	getTags()
Object	getTagValue(OBOFormatConstants.OboFormatTag tag)
<T> T	getTagValue(OBOFormatConstants.OboFormatTag tag, Class<T> cls)
Object	getTagValue(String tag)
<T> T	getTagValue(String tag, Class<T> cls)
Collection<Object>	getTagValues(OBOFormatConstants.OboFormatTag tag)
<T> Collection<T>	getTagValues(OBOFormatConstants.OboFormatTag tag, Class<T> cls)
Collection<Object>	getTagValues(String tag)
<T> Collection<T>	getTagValues(String tag, Class<T> cls)
Collection<Xref>	getTagXrefs(String tag)
Frame.FrameType	getType()
void	merge(Frame extFrame)
void	setClauses(Collection<Clause> clauses)
void	setId(String id)
void	setType(Frame.FrameType type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Frame

public Frame()

Instantiates a new frame.

Frame

public Frame(@Nullable
             Frame.FrameType type)

Instantiates a new frame.

Parameters:

type - the type

Method Detail

freeze

public void freeze()

freezing a frame signals that a frame has become quiescent, and that data structures can be adjusted to increase performance or reduce memory consumption. If a frozen frame is subsequently modified it will be thawed as necessary.

getType

@Nullable
public Frame.FrameType getType()

Returns:

the type

setType

public void setType(Frame.FrameType type)

Parameters:

type - the new type

getId

@Nullable
public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - the new id

getClauses

public Collection<Clause> getClauses()

Returns:

the clauses

setClauses

public void setClauses(Collection<Clause> clauses)

Parameters:

clauses - the new clauses

getClauses

public List<Clause> getClauses(@Nullable
                               String tag)

Parameters:

tag - the tag

Returns:

the clauses for tag

getClauses

public List<Clause> getClauses(OBOFormatConstants.OboFormatTag tag)

Parameters:

tag - the tag

Returns:

the clauses for tag

getClause

@Nullable
public Clause getClause(@Nullable
                                  String tag)

Parameters:

tag - the tag

Returns:

null if no value set, otherwise first value

getClause

@Nullable
public Clause getClause(OBOFormatConstants.OboFormatTag tag)

Parameters:

tag - the tag

Returns:

the clause for tag

addClause

public void addClause(Clause cl)

Parameters:

cl - the clause

toString

public String toString()

Overrides:

toString in class Object

getTagValue

@Nullable
public Object getTagValue(String tag)

Parameters:

tag - the tag

Returns:

the tag value for tag

getTagValue

@Nullable
public Object getTagValue(OBOFormatConstants.OboFormatTag tag)

Parameters:

tag - the tag

Returns:

the tag value for tag

getTagValue

@Nullable
public <T> T getTagValue(String tag,
                                   Class<T> cls)

Type Parameters:

T - the generic type

Parameters:

tag - the tag

cls - the class

Returns:

the tag value for tag and class

getTagValue

@Nullable
public <T> T getTagValue(OBOFormatConstants.OboFormatTag tag,
                                   Class<T> cls)

Type Parameters:

T - the generic type

Parameters:

tag - the tag

cls - the class

Returns:

the tag value for tag and class

getTagValues

public Collection<Object> getTagValues(OBOFormatConstants.OboFormatTag tag)

Parameters:

tag - the tag

Returns:

the tag values for tag

getTagValues

public Collection<Object> getTagValues(String tag)

Parameters:

tag - the tag

Returns:

the tag values for tag

getTagValues

public <T> Collection<T> getTagValues(OBOFormatConstants.OboFormatTag tag,
                                      Class<T> cls)

Type Parameters:

T - the generic type

Parameters:

tag - the tag

cls - the class

Returns:

the tag values for tag and class

getTagValues

public <T> Collection<T> getTagValues(String tag,
                                      Class<T> cls)

Type Parameters:

T - the generic type

Parameters:

tag - the tag

cls - the class

Returns:

the tag values for tag and class

getTagXrefs

public Collection<Xref> getTagXrefs(String tag)

Parameters:

tag - the tag

Returns:

the tag xref list for tag

getTags

public Set<String> getTags()

Returns:

the tags

merge

public void merge(Frame extFrame)
           throws FrameMergeException

Parameters:

extFrame - the external frame

Throws:

FrameMergeException - the frame merge exception

check

public void check()

Check this frame for violations, i.e. cardinality constraint violations.

Throws:

FrameStructureException - the frame structure exception

See Also:

for equivalent checks in OWL