org.lenskit.data.entities

Class EntityDefaults

java.lang.Object

org.lenskit.data.entities.EntityDefaults

public class EntityDefaults
extends java.lang.Object

Descriptor for the default characteristics of an entity type.

Constructor Summary

Constructors

Constructor and Description
EntityDefaults(EntityType type, java.util.Collection<TypedName<?>> attrs, java.util.List<TypedName<?>> cols, java.lang.Class<? extends EntityBuilder> bld, java.util.List<EntityDerivation> derivs) Construct a set of entity defaults.
EntityDefaults(EntityType type, java.util.List<TypedName<?>> cols) Construct a set of entity defaults where all common attributes are default columns.

Method Summary

Modifier and Type	Method and Description
TypedName<?>	getAttributeDefaults(java.lang.String name) Look up the default attribute descriptor (typed name) for a particular attribute name.
java.util.Set<TypedName<?>>	getCommonAttributes() Get the set of attributes that can typically be associated with this entity type.
java.lang.Class<? extends EntityBuilder>	getDefaultBuilder() Get the default entity builder for this entity type.
java.util.List<TypedName<?>>	getDefaultColumns() Get the default columns for an entity type.
java.util.List<EntityDerivation>	getDefaultDerivations() Get the default entity derivations.
EntityType	getEntityType() Get the entity type this set of defaults describes.
static EntityDefaults	lookup(EntityType type) Look up the defaults for a particular entity type.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityDefaults

public EntityDefaults(EntityType type,
                      java.util.List<TypedName<?>> cols)

Construct a set of entity defaults where all common attributes are default columns.

Parameters:

type - The entity type.

cols - The default column layout.

EntityDefaults

public EntityDefaults(EntityType type,
                      java.util.Collection<TypedName<?>> attrs,
                      java.util.List<TypedName<?>> cols,
                      java.lang.Class<? extends EntityBuilder> bld,
                      java.util.List<EntityDerivation> derivs)

Construct a set of entity defaults.

Parameters:

type - The entity type.

attrs - The well-known attributes.

cols - The default column layout.

Method Detail

lookup

@Nullable
public static EntityDefaults lookup(EntityType type)

Look up the defaults for a particular entity type.

Parameters:

type - The entity type.

Returns:

The defaults.

getEntityType

public EntityType getEntityType()

Get the entity type this set of defaults describes.

Returns:

The entity type.

getAttributeDefaults

public TypedName<?> getAttributeDefaults(java.lang.String name)

Look up the default attribute descriptor (typed name) for a particular attribute name.

Parameters:

name - The attribute name.

Returns:

The attribute’s typed name, or null if the attribute is not predefined for the entity type.

getCommonAttributes

public java.util.Set<TypedName<?>> getCommonAttributes()

Get the set of attributes that can typically be associated with this entity type.

Returns:

The set of common attributes for this type.

getDefaultColumns

public java.util.List<TypedName<?>> getDefaultColumns()

Get the default columns for an entity type. These are used as defaults when reading entities of this type from a columnar storage format.

Returns:

The default columns for the entity type.

getDefaultBuilder

public java.lang.Class<? extends EntityBuilder> getDefaultBuilder()

Get the default entity builder for this entity type.

Returns:

The default entity builder.

getDefaultDerivations

public java.util.List<EntityDerivation> getDefaultDerivations()

Get the default entity derivations.

Returns:

The default entity derivations.