Package org.biojava.bio
Class AnnotationType.Impl
java.lang.Object
org.biojava.bio.AnnotationType.Abstract
org.biojava.bio.AnnotationType.Impl
- All Implemented Interfaces:
AnnotationType
- Enclosing interface:
AnnotationType
An implementation of AnnotationType
.
To build an instance of AnnotationType.Impl
,
first invoke the no-args constructor, and then use the
setPropertyConstraint method to build the property->constraint
mapping.
- Since:
- 1.3
- Author:
- Matthew Pocock, Thomas Down
-
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
ConstructorsConstructorDescriptionImpl()
Create a new Impl with no constraints.Impl
(CollectionConstraint unknown) Create a new Impl with a default collection constraint.Impl
(PropertyConstraint defaultPC, Location defaultCC) Create a new Impl with a default property and cardinality constraint. -
Method Summary
Modifier and TypeMethodDescriptionGet the comment for the whole AnnotationType.getComment
(Object key) Get the comment for a particular property.getConstraint
(Object key) Retrieve the constraint that will be applied to all properties with a given key.Get the CollectionConstraint that will be applied to all properties without an explicit binding.Retrieve the set of properties for which constraints have been explicity specified.void
setComment
(Object key, String comment) Set the comment for a particular property.void
setComment
(String comment) Set the comment for the whole AnnotationType.void
setConstraint
(Object key, CollectionConstraint cc) Specifies the constraint to apply to the specified property.void
Specifies the default constraint to apply to properties where no other constraint is specified.Methods inherited from class org.biojava.bio.AnnotationType.Abstract
addProperty, getProperty, instanceOf, removeProperty, setConstraints, setDefaultConstraints, setProperty, subTypeOf, toString
-
Constructor Details
-
Impl
public Impl()Create a new Impl with no constraints. -
Impl
Create a new Impl with a default property and cardinality constraint.- Parameters:
defaultPC
- the default PropertyConstraintdefaultCC
- the default CardinalityConstraint
-
Impl
Create a new Impl with a default collection constraint.- Parameters:
unknown
- the default CollectionConstraint
-
-
Method Details
-
setDefaultConstraint
Description copied from interface:AnnotationType
Specifies the default constraint to apply to properties where no other constraint is specified.- Parameters:
cc
- The default constraint.
-
getDefaultConstraint
Description copied from interface:AnnotationType
Get the CollectionConstraint that will be applied to all properties without an explicit binding. This defaults to CollectionConstraint.ALL.If you want to find out exactly what constraint will be applied to properties with no explicitly defined constraints
- Returns:
- the default CollectionConstraint
-
getConstraint
Description copied from interface:AnnotationType
Retrieve the constraint that will be applied to all properties with a given key.
For an
If you want to find out exactly what constraints will be applied to a particular propery keyAnnotation
to be accepted, each key in getProperties() must be present in the annotation and each of the values associated with those properties must match the constraint.- Parameters:
key
- the property to be validated.- Returns:
- PropertyConstraint the constraint by which the values must be accepted.
-
setConstraint
Description copied from interface:AnnotationType
Specifies the constraint to apply to the specified property.- Parameters:
key
- the name of the property to constraincc
- the constraint to apply to this slot.
-
getProperties
Description copied from interface:AnnotationType
Retrieve the set of properties for which constraints have been explicity specified. Discover which properties have explicit constraints- Returns:
- the Set of properties to validate.
-
setComment
Description copied from interface:AnnotationType
Set the comment for the whole AnnotationType. This is human-readable text.- Parameters:
comment
- the new comment
-
getComment
Description copied from interface:AnnotationType
Get the comment for the whole AnnotationType. This is human-readable text.- Returns:
- the comment
-
setComment
Description copied from interface:AnnotationType
Set the comment for a particular property. This is a human-readable description of the property.- Parameters:
key
- the property to comment oncomment
- the comment
-
getComment
Description copied from interface:AnnotationType
Get the comment for a particular property. This is a human-readable description of the property.- Parameters:
key
- the property to get a comment for- Returns:
- the comment
-