ddf.catalog.data

Interface AttributeInjector

All Known Implementing Classes:

AttributeInjectorImpl

public interface AttributeInjector

Manages InjectableAttribute services and injects the appropriate AttributeDescriptors into MetacardTypes and into Metacards.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method and Description
Metacard	injectAttributes(Metacard original) 'Injects' AttributeDescriptors (represented by 'global' InjectableAttributes and InjectableAttributes specific to original's metacard type) into the given Metacard by returning a new Metacard with the same data as original but with a new MetacardType containing the additional injected AttributeDescriptors.
MetacardType	injectAttributes(MetacardType original) 'Injects' AttributeDescriptors (represented by 'global' InjectableAttributes and InjectableAttributes specific to original) into the given MetacardType by returning a new MetacardType with the same name as original and containing the additional injected AttributeDescriptors.

Method Detail

injectAttributes

MetacardType injectAttributes(MetacardType original)

'Injects' AttributeDescriptors (represented by 'global' InjectableAttributes and InjectableAttributes specific to original) into the given MetacardType by returning a new MetacardType with the same name as original and containing the additional injected AttributeDescriptors.

If there are no attributes to inject for the given MetacardType, original is returned.

Parameters:

original - the original MetacardType, cannot be null

Returns:

a new MetacardType with the same name as original and containing the additional injected AttributeDescriptors, or original if there are no attributes to inject

Throws:

IllegalArgumentException - if original is null

injectAttributes

Metacard injectAttributes(Metacard original)

'Injects' AttributeDescriptors (represented by 'global' InjectableAttributes and InjectableAttributes specific to original's metacard type) into the given Metacard by returning a new Metacard with the same data as original but with a new MetacardType containing the additional injected AttributeDescriptors.

If there are no attributes to inject for the given Metacard's metacard type, original is returned.

Parameters:

original - the original Metacard, cannot be null

Returns:

a new Metacard containing the same data as original but with a new MetacardType containing the additional injected AttributeDescriptors, or original if there are no attributes to inject

Throws:

IllegalArgumentException - if original is null