Package cz.cvut.kbss.jopa.model.metamodel

Interface FieldSpecification<X,E>

Type Parameters:
X - Declaring class
E - Type of the field
All Known Subinterfaces:
Attribute<X,Y>, CollectionAttribute<X,E>, Identifier<X,E>, IRIIdentifier, ListAttribute<X,E>, MapAttribute<X,K,V>, PluralAttribute<X,C,E>, PluralQueryAttribute<X,C,E>, PropertiesSpecification<X,E,K,V>, QueryAttribute<X,Y>, RDFContainerAttribute<X,C,E>, SetAttribute<X,E>, SingularAttribute<X,T>, SingularQueryAttribute<X,T>, TypesSpecification<X,E>
All Known Implementing Classes:
AbstractAttribute, AbstractPluralAttribute, AbstractQueryAttribute, CollectionAttributeImpl, IRIIdentifierImpl, ListAttributeImpl, PluralQueryAttributeImpl, PropertiesSpecificationImpl, RDFCollectionAttribute, RdfContainerAttributeImpl, SetAttributeImpl, SingularAttributeImpl, SingularQueryAttributeImpl, TypesSpecificationImpl
public interface FieldSpecification<X,E>
Specifies a field of a managed type.

  • Method Summary

    Modifier and Type
    Method
    Description
    ManagedType<X>
    getDeclaringType()
    Return the managed type representing the type in which the attribute was declared.
    FetchType
    getFetchType()
    Whether the association is lazily loaded or must be eagerly fetched.
    Field
    getJavaField()
    Return the java.lang.reflect.Member for the represented attribute.
    Class<E>
    getJavaType()
    Return the Java type of the represented attribute.
    String
    getName()
    Return the name of the attribute.
    boolean
    includeExplicit()
    If this field is inferred, can it contain explicit data as well?
    boolean
    isCollection()
    Is the attribute collection-valued (represents a Collection, Set, List, or Map).
    boolean
    isInferred()
    Whether this field can contain inferred data.
    default boolean
    isMappedAttribute()
    Whether the attribute is mapped to an ontological property.

  • Method Details

    • getDeclaringType

      ManagedType<X> getDeclaringType()
      Return the managed type representing the type in which the attribute was declared.
      Returns:
      declaring type

    • getJavaType

      Class<E> getJavaType()
      Return the Java type of the represented attribute.
      Returns:
      Java type

    • getJavaField

      Field getJavaField()
      Return the java.lang.reflect.Member for the represented attribute.
      Returns:
      corresponding java.lang.reflect.Member

    • getFetchType

      FetchType getFetchType()
      Whether the association is lazily loaded or must be eagerly fetched.
      Returns:
      Fetch type of the field specification

    • isInferred

      boolean isInferred()
      Whether this field can contain inferred data.
      Returns:
      Whether field is inferred
      See Also:

    • includeExplicit

      boolean includeExplicit()
      If this field is inferred, can it contain explicit data as well?
      Returns:
      Whether inferred field can contain explicit knowledge
      See Also:

    • getName

      String getName()
      Return the name of the attribute.
      Returns:
      name

    • isCollection

      boolean isCollection()
      Is the attribute collection-valued (represents a Collection, Set, List, or Map).
      Returns:
      boolean indicating whether the attribute is collection-valued

    • isMappedAttribute

      default boolean isMappedAttribute()
      Whether the attribute is mapped to an ontological property.
      Returns:
      true if the attribute is mapped to an ontological property, false otherwise