|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.biojava.bio.AnnotationType.Abstract
public abstract static class AnnotationType.Abstract
An abstract base class useful for implementing AnnotationType instances.
This provides deffinitions for the logical operators (validate(), subTypeOf()), the mutators (setProperty(), getProperty() and deleteProperty()) and toString() that you may not want to write yourself. It leaves the data-related methods up to you.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.biojava.bio.AnnotationType |
---|
AnnotationType.Abstract, AnnotationType.Impl |
Field Summary |
---|
Fields inherited from interface org.biojava.bio.AnnotationType |
---|
ANY, NONE |
Constructor Summary | |
---|---|
AnnotationType.Abstract()
|
Method Summary | |
---|---|
void |
addProperty(Annotation ann,
Object key,
Object value)
Add a value to the specified property slot. |
Collection |
getProperty(Annotation ann,
Object property)
Get the Collection of values associated with an Annotation bundle according to the type we believe it to be. |
boolean |
instanceOf(Annotation ann)
Validate an Annotation against this AnnotationType. |
void |
removeProperty(Annotation ann,
Object key,
Object value)
Remove a value from the specified property slot. |
void |
setConstraints(Object key,
PropertyConstraint pc,
Location cc)
Set the constraints associated with a property. |
void |
setDefaultConstraints(PropertyConstraint pc,
Location cc)
Set the constraints that will apply to all properties without an explicitly defined set of constraints. |
void |
setProperty(Annotation ann,
Object property,
Object value)
Set the property in an annotation bundle according to the type we believe it should be. |
boolean |
subTypeOf(AnnotationType subType)
See if an AnnotationType is a specialisation of this type. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.biojava.bio.AnnotationType |
---|
getComment, getComment, getConstraint, getDefaultConstraint, getProperties, setComment, setComment, setConstraint, setDefaultConstraint |
Constructor Detail |
---|
public AnnotationType.Abstract()
Method Detail |
---|
public void setConstraints(Object key, PropertyConstraint pc, Location cc)
AnnotationType
con
, and the number of members must match card
.
It implicitly constructs a CollectionConstraint.AllValuesIn
instance.
When you are building your own AnnotationType
setConstraints
in interface AnnotationType
key
- the name of the property to constrainpc
- the PropertyConstraint to enforcecc
- the CardinalityConstraint to enforcepublic void setDefaultConstraints(PropertyConstraint pc, Location cc)
AnnotationType
con
, and the number of members must match card
.
It implicitly constructs a CollectionConstraint.AllValuesIn
instance.
setDefaultConstraints
in interface AnnotationType
pc
- the default PropertyConstraintcc
- the default CardinalityConstraintpublic boolean instanceOf(Annotation ann)
AnnotationType
instanceOf
in interface AnnotationType
ann
- the Annotation to validate.
public final void setProperty(Annotation ann, Object property, Object value) throws ChangeVetoException
AnnotationType
setProperty
in interface AnnotationType
ann
- the Annotation to modifyproperty
- the property key Objectvalue
- the property value Object
ChangeVetoException
- if the value could not be accepted by this
annotation type for that property key, or if the Annotation could
not be modifiedpublic final Collection getProperty(Annotation ann, Object property) throws ChangeVetoException
AnnotationType
getProperty
in interface AnnotationType
ann
- the Annotation to accessproperty
- the property key Object
ChangeVetoException
- if the value could not be removedpublic final void addProperty(Annotation ann, Object key, Object value) throws ChangeVetoException
AnnotationType
addProperty
in interface AnnotationType
ann
- the Annotation to modifykey
- the property key Objectvalue
- the property value Object
ChangeVetoException
- if the value could not be accepted by this
annotation type for that property key, or if the Annotation could
not be modifiedpublic final void removeProperty(Annotation ann, Object key, Object value) throws ChangeVetoException
AnnotationType
removeProperty
in interface AnnotationType
ann
- the Annotation to modifykey
- the property key Objectvalue
- the property value Object
ChangeVetoException
- if the Annotation could
not be modifiedpublic String toString()
toString
in class Object
public boolean subTypeOf(AnnotationType subType)
AnnotationType
See if an AnnotationType is a specialisation of this type.
An AnnotationType is a sub-type if it restricts each of the properties of the super-type to a type that can be cast to the type in the super-type. Note that this is not always a cast in the pure Java sense; it may include checks on the number and type of members in collections or other criteria.
subTypeOf
in interface AnnotationType
subType
- an AnnotationType to check.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |