Index (prospecto-api 1.8.0 API)

A B C D E F G I J L M N O P R S T U V W
All Classes All Packages

A

AbstractArrayAssociationManager<T,E> - Class in org.soulwing.prospecto.api.association: An abstract base for a manager of an indexed to-many association that is based on an array.
AbstractArrayAssociationManager() - Constructor for class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
AbstractAssociationManager<T,E> - Class in org.soulwing.prospecto.api.association: An abstract base for AssociationManager implementations.
AbstractAssociationManager() - Constructor for class org.soulwing.prospecto.api.association.AbstractAssociationManager
AbstractCollectionAssociationManager<T,E> - Class in org.soulwing.prospecto.api.association: An abstract base for a manager of a to-many association that is based on q Collection.
AbstractCollectionAssociationManager() - Constructor for class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager
AbstractListAssociationManager<T,E> - Class in org.soulwing.prospecto.api.association: An abstract base for a manager of an indexed to-many association that is based on a List.
AbstractListAssociationManager() - Constructor for class org.soulwing.prospecto.api.association.AbstractListAssociationManager
AbstractToManyAssociationManager<T,E> - Class in org.soulwing.prospecto.api.association: An abstract base for ToManyAssociationManager implementations.
AbstractToManyAssociationManager() - Constructor for class org.soulwing.prospecto.api.association.AbstractToManyAssociationManager
AbstractToManyIndexedAssociationManager<T,E> - Class in org.soulwing.prospecto.api.association: An abstract base for ToManyIndexedAssociationManager implementations.
AbstractToManyIndexedAssociationManager() - Constructor for class org.soulwing.prospecto.api.association.AbstractToManyIndexedAssociationManager
AbstractToOneAssociationManager<T,E> - Class in org.soulwing.prospecto.api.association: An abstract base for ToOneAssociationManager implementations.
AbstractToOneAssociationManager() - Constructor for class org.soulwing.prospecto.api.association.AbstractToOneAssociationManager
AbstractViewNodeVisitor - Class in org.soulwing.prospecto.api.template: An abstract base for a ViewNodeVisitor implementation.
AbstractViewNodeVisitor() - Constructor for class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
AccessMode - Enum in org.soulwing.prospecto.api: An enumeration of access modes for model properties.
accessType(AccessType) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies the access type that will be used to access the model property associated with the node at the cursor.
AccessType - Enum in org.soulwing.prospecto.api: An enumeration of access types for accessing model properties.
add(T, int, E) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
add(T, int, E) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Adds an associate to the list of associates.
add(T, int, E) - Method in interface org.soulwing.prospecto.api.association.ToManyIndexedAssociationManager: Adds (inserts) an associate of the given owner at a specified index.
add(T, E) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
add(T, E) - Method in class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager: Adds an associate to the collection of associates.
add(T, E) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Adds an associate to the list of associates.
add(T, E) - Method in interface org.soulwing.prospecto.api.association.ToManyAssociationManager: Adds an associate from the collection.
afterTraversing(ViewTraversalEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewPostTraversalListener: Notifies the recipient that a view template was traversed to generate or a apply a view.
allow(EnumSet<AccessMode>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies the access modes that will be allowed on the model property associated with the node at the cursor.
allow(AccessMode, AccessMode...) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies the access modes that will be allowed on the model property associated with the node at the cursor.
append(AssociationManager) - Method in interface org.soulwing.prospecto.api.association.AssociationManagers: Appends the given manager to the end of the collection.
append(ValueTypeConverter) - Method in interface org.soulwing.prospecto.api.converter.ValueTypeConverters: Appends the given converter to the end of the collection.
append(ObjectFactory) - Method in interface org.soulwing.prospecto.api.factory.ObjectFactories: Appends a factory to the collection.
append(ViewListener) - Method in interface org.soulwing.prospecto.api.listener.ViewListeners: Appends the given listener to the end of the collection.
append(ReferenceResolver) - Method in interface org.soulwing.prospecto.api.reference.ReferenceResolvers: Appends a resolver to the collection.
append(Scope) - Method in interface org.soulwing.prospecto.api.scope.Scopes: Appends the given scope to the end of the collection.
appendScope() - Method in interface org.soulwing.prospecto.api.ViewContext: Creates a new mutable scope appending it to the list of scopes on this context.
AppliableNode - Interface in org.soulwing.prospecto.api.template: A marker interface that identifies view nodes that participate in an apply operation.
apply(JsonStructure, SpliceNode, ViewContext) - Method in interface org.soulwing.prospecto.api.json.JsonSpliceHandler.Consumer
apply(SpliceNode, ViewContext) - Method in interface org.soulwing.prospecto.api.json.JsonSpliceHandler.Producer
apply(SpliceNode, View, ViewContext) - Method in class org.soulwing.prospecto.api.json.JsonSpliceHandler
apply(SpliceNode, View, ViewContext) - Method in interface org.soulwing.prospecto.api.splice.SpliceHandler: Uses the provided view to manipulate the model associated with the splice.
apply(SpliceNode, View, ViewContext) - Method in class org.soulwing.prospecto.api.splice.ViewGeneratingSpliceHandler: Allows a subtype to provide an implementation for applying the subview associated with a splice to a model.
APPLY - org.soulwing.prospecto.api.listener.ViewMode
ArrayNode - Interface in org.soulwing.prospecto.api.template: A node that represents an array structure.
arrayOfObjects(Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of array-of-objects type.
arrayOfObjects(String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-objects node at the cursor.
arrayOfObjects(String, Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of array-of-objects type.
arrayOfObjects(String, String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-objects node at the cursor.
arrayOfObjects(String, String, Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of array-of-objects type.
arrayOfObjects(String, String, String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-objects node at the cursor.
arrayOfObjects(String, String, String, Class<?>) - Method in interface org.soulwing.prospecto.spi.ViewTemplateBuilderProvider: Creates a builder for a view whose root node is an array-of-objects node.
arrayOfObjects(String, String, String, Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of array-of-objects type.
arrayOfObjects(String, String, String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-objects node at the cursor using the root node of the given template.
arrayOfObjects(String, String, String, ViewTemplate) - Method in interface org.soulwing.prospecto.spi.ViewTemplateBuilderProvider: Creates a view template whose root node is an array-of-objects node using the children of the root node of the given object template.
arrayOfObjects(String, String, String, ViewTemplate) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a view template whose root node is an array-of-objects node using the children of the root node of the given object template.
arrayOfObjects(String, String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-objects node at the cursor using the root node of the given template.
arrayOfObjects(String, String, ViewTemplate) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a view template whose root node is an array-of-objects node using the children of the root node of the given object template.
arrayOfObjects(String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-objects node at the cursor using the root node of the given template.
arrayOfObjects(String, ViewTemplate) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a view template whose root node is an array-of-objects node using the children of the root node of the given object template.
arrayOfObjects(ViewTemplate) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a view template whose root node is an array-of-objects node using the children of the root node of the given object template.
ArrayOfObjectsNode - Interface in org.soulwing.prospecto.api.template: A ViewNode representing an array-of-objects structure.
arrayOfReferences(String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor.
arrayOfReferences(String, String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor.
arrayOfReferences(String, String, String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor.
arrayOfReferences(String, String, String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor using the root node of the given template.
arrayOfReferences(String, String, String, ViewTemplate) - Method in interface org.soulwing.prospecto.spi.ViewTemplateBuilderProvider: Creates a view template whose root node is an array-of-references node using the children of the root node of the given object template.
arrayOfReferences(String, String, String, ViewTemplate) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a view template whose root node is an array-of-references node using the children of the root node of the given object template.
arrayOfReferences(String, String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor using the root node of the given template.
arrayOfReferences(String, String, ViewTemplate) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a view template whose root node is an array-of-references node using the children of the root node of the given object template.
arrayOfReferences(String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor using the root node of the given template.
arrayOfReferences(String, ViewTemplate) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a view template whose root node is an array-of-references node using the children of the root node of the given object template.
arrayOfReferences(ViewTemplate) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a view template whose root node is an array-of-references node using the children of the root node of the given object template.
ArrayOfReferencesNode - Interface in org.soulwing.prospecto.api.template: A ViewNode representing an array-of-objects structure where each object is a resolvable reference.
arrayOfValues() - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template whose root node type is of array-of-values type.
arrayOfValues(String) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template whose root node type is of array-of-values type.
arrayOfValues(String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-values node at the cursor.
arrayOfValues(String, String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-values at the cursor.
arrayOfValues(String, String, String) - Method in interface org.soulwing.prospecto.spi.ViewTemplateBuilderProvider: Creates a view template whose root node is an array-of-values node.
arrayOfValues(String, String, String) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template whose root node type is of array-of-values type.
arrayOfValues(String, String, String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an array-of-values at the cursor.
ArrayOfValuesNode - Interface in org.soulwing.prospecto.api.template: A ViewNode representing an array-of-values structure.
AssociationDescriptor - Interface in org.soulwing.prospecto.api.association: A descriptor for an association between model objects.
AssociationManager<T,E> - Interface in org.soulwing.prospecto.api.association: A marker interface for association managers.
AssociationManagers - Interface in org.soulwing.prospecto.api.association: A mutable ordered collection of AssociationManager instances.
attribute(Object) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Puts an attribute into the scope associated with the node at the cursor.
attribute(String, Object) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Puts an attribute into the scope associated with the node at the cursor.

B

beforeTraversing(ViewTraversalEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewPreTraversalListener: Notifies the recipient that a view template is about to be traversed to generate or a apply a view.
begin(T) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
begin(T) - Method in class org.soulwing.prospecto.api.association.AbstractToManyAssociationManager: Begins a transaction for updating the associated collection.
begin(T) - Method in interface org.soulwing.prospecto.api.association.ToManyAssociationManager: Begins a transaction for updating the associated collection.
BEGIN_ARRAY - org.soulwing.prospecto.api.View.Event.Type
BEGIN_OBJECT - org.soulwing.prospecto.api.View.Event.Type
breadthFirst() - Method in interface org.soulwing.prospecto.api.ViewTemplate: Creates a new breadth first traversal.
build() - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter.Builder: Builds the converter.
build() - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter.Builder: Builds the converter.
build() - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter.Builder
build() - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy.Builder
build() - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Builds the template that corresponds to the node tree structure contained in this builder instance.
Builder() - Constructor for class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy.Builder

C

CalendarTypeConverter - Class in org.soulwing.prospecto.api.converter: A ValueTypeConverter that converts Calendar objects to and from a string representation.
CalendarTypeConverter() - Constructor for class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Constructs a new instance that uses ISO 8601 format.
CalendarTypeConverter(String) - Constructor for class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Constructs an instance that uses a custom pattern.
CalendarTypeConverter(DateTypeConverter.Format) - Constructor for class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Constructs an instance that uses a specific format.
CalendarTypeConverter.Builder - Class in org.soulwing.prospecto.api.converter: A builder that produces a CalendarTypeConverter.
clear(T) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
clear(T) - Method in class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager: Clears the collection of associates.
clear(T) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Clears the list of associates.
clear(T) - Method in interface org.soulwing.prospecto.api.association.ToManyAssociationManager: Removes all associates from the collection.
clone() - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
clone() - Method in interface org.soulwing.prospecto.api.association.Stateful: Creates a clone of the recipient object.
Coerce - Class in org.soulwing.prospecto.api.converter: A type coercion utility.
Coerce() - Constructor for class org.soulwing.prospecto.api.converter.Coerce
complement() - Method in enum org.soulwing.prospecto.api.View.Event.Type: Gets the complement of this type.
consumeValue(MetaNode, Object, Object, ViewContext) - Method in class org.soulwing.prospecto.api.meta.LiteralMetadataHandler
consumeValue(MetaNode, Object, Object, ViewContext) - Method in interface org.soulwing.prospecto.api.meta.MetadataHandler: Consumes a value for the given node.
ContainerNode - Interface in org.soulwing.prospecto.api.template: A node that contains other nodes as children.
converter(Class<? extends ValueTypeConverter>, Object...) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies a converter that will be used to transform the model property associated with the node at the cursor.
converter(Class<? extends ValueTypeConverter>, Map) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies a converter that will be used to transform the model property associated with the node at the cursor.
converter(ValueTypeConverter) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies a converter that will be used to transform the model property associated with the node at the cursor.
copy() - Method in interface org.soulwing.prospecto.api.ViewContext: Creates a (deep) copy of this view context;
create() - Method in interface org.soulwing.prospecto.api.ViewApplicator: Creates a new instance of the model type represented by the source view, and injects it with the properties represented in the view.
createApplicator(View, ViewContext) - Method in interface org.soulwing.prospecto.api.ViewTemplate: Creates a view applicator using the given source view.
createApplicator(View, ViewContext, String) - Method in interface org.soulwing.prospecto.api.ViewTemplate: Creates a view applicator using the given enveloped source view.
currentModelPath() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the sequence of model types encountered on view nodes of type object and array-of-object that form the model path to the current view node as a template is being evaluated to produce a view.
currentViewPath() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the sequence of view node names that form the path to the current view node as a template is being evaluated to produce a view.
currentViewPathAsString() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the sequence of view node names that form the path to the current view node as a template is being evaluated to produce a view.
CUSTOM - org.soulwing.prospecto.api.converter.DateTypeConverter.Format

D

DateTypeConverter - Class in org.soulwing.prospecto.api.converter: A ValueTypeConverter that converts Date objects to and from a string representation.
DateTypeConverter() - Constructor for class org.soulwing.prospecto.api.converter.DateTypeConverter: Constructs a new instance that uses ISO 8601 format.
DateTypeConverter(String) - Constructor for class org.soulwing.prospecto.api.converter.DateTypeConverter: Constructs an instance that uses a custom pattern.
DateTypeConverter(DateTypeConverter.Format) - Constructor for class org.soulwing.prospecto.api.converter.DateTypeConverter: Constructs an instance that uses a specific format.
DateTypeConverter.Builder - Class in org.soulwing.prospecto.api.converter: A builder that produces a DateTypeConverter.
DateTypeConverter.Format - Enum in org.soulwing.prospecto.api.converter
decapitalize() - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy.Builder
depthFirst() - Method in interface org.soulwing.prospecto.api.ViewTemplate: Creates a new breadth first traversal.
destroy() - Method in interface org.soulwing.prospecto.spi.UrlResolverProvider: Prepares this provider to be discarded.
destroy() - Static method in class org.soulwing.prospecto.UrlResolverProducer: Prepares the URL resolver provider to be discarded.
didExtractValue(ViewNodePropertyEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewNodePropertyInterceptor: Notifies the recipient that a value has been extracted from a model for use as the value of a view node in a view.
discriminator() - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a subtype discriminator at the cursor.
discriminator(Class<? extends DiscriminatorStrategy>, Object...) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a subtype discriminator at the cursor.
discriminator(Class<? extends DiscriminatorStrategy>, Map) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a subtype discriminator at the cursor.
discriminator(DiscriminatorStrategy) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a subtype discriminator at the cursor.
Discriminator - Class in org.soulwing.prospecto.api.discriminator: An immutable value holder that describes a subtype discriminator.
Discriminator(Object) - Constructor for class org.soulwing.prospecto.api.discriminator.Discriminator: Constructs a new discriminator using the default name and the specified value.
DISCRIMINATOR - org.soulwing.prospecto.api.View.Event.Type
DISCRIMINATOR_NAME - Static variable in interface org.soulwing.prospecto.api.options.ViewKeys: Subtype discriminator property name.
DISCRIMINATOR_NODE_NAME - Static variable in interface org.soulwing.prospecto.api.options.ViewDefaults: Default name for a discriminator node.
DiscriminatorStrategy - Interface in org.soulwing.prospecto.api.discriminator: A strategy that produces a Discriminator for a given model type.

E

end() - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Moves the cursor to the parent of the cursor node.
end(T) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
end(T) - Method in class org.soulwing.prospecto.api.association.AbstractToManyAssociationManager: Ends a transaction that has updated the associated collection.
end(T) - Method in interface org.soulwing.prospecto.api.association.ToManyAssociationManager: Ends a transaction that has updated the associated collection.
END_ARRAY - org.soulwing.prospecto.api.View.Event.Type
END_OBJECT - org.soulwing.prospecto.api.View.Event.Type
entityCreated(ViewNodePropertyEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewNodeEntityListener: Notifies the recipient that a model entity was created and added to the model.
entityDiscarded(ViewNodePropertyEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewNodeEntityListener: Notifies the recipient that a model entity was removed from the model and is to be discarded.
ENUM_NODE_NAME - Static variable in interface org.soulwing.prospecto.api.options.ViewDefaults: Default name for an enum name value node.
envelope() - Method in interface org.soulwing.prospecto.api.View: Gets the envelope for this view.
envelope(String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an envelope node at the cursor.
envelope(String, String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an envelope node at the cursor.
EnvelopeNode - Interface in org.soulwing.prospecto.api.template: A ViewNode representing an envelope structure.

F

FIELD - org.soulwing.prospecto.api.AccessType: use direct field access
findAssociate(T, ViewEntity, ObjectFactory) - Method in class org.soulwing.prospecto.api.association.AbstractToManyAssociationManager: Finds the associate of the given owner that is logically equivalent to given view entity.
findAssociate(T, ViewEntity, ObjectFactory) - Method in interface org.soulwing.prospecto.api.association.ToManyAssociationManager: Finds the associate of owner that matches the given entity.
format(DateTypeConverter.Format) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter.Builder: Configures the format property.
format(DateTypeConverter.Format) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter.Builder: Configures the format property.

G

generate(SpliceNode, ViewContext) - Method in class org.soulwing.prospecto.api.json.JsonSpliceHandler
generate(SpliceNode, ViewContext) - Method in interface org.soulwing.prospecto.api.splice.SpliceHandler: Generates the subview for a splice.
generate(SpliceNode, ViewContext) - Method in class org.soulwing.prospecto.api.splice.ViewGeneratingSpliceHandler: Generates a View using a ViewTemplate specified as an attribute of the given node.
GENERATE - org.soulwing.prospecto.api.listener.ViewMode
generateView(Object, ViewContext) - Method in interface org.soulwing.prospecto.api.ViewTemplate: Generates a view using the given model as the root object represented by the view.
get(Class<T>) - Method in interface org.soulwing.prospecto.api.scope.Scope: Gets a singleton object of the given type.
get(Class<T>) - Method in interface org.soulwing.prospecto.api.ViewContext: Gets a singleton object of the given type.
get(String) - Method in interface org.soulwing.prospecto.api.options.Options: Gets the value of the named option.
get(String) - Method in class org.soulwing.prospecto.api.options.OptionsMap
get(String) - Method in interface org.soulwing.prospecto.api.ViewEntity: Gets a property of the entity.
get(String, Class<T>) - Method in interface org.soulwing.prospecto.api.scope.Scope: Gets a named object of the given type.
get(String, Class<T>) - Method in interface org.soulwing.prospecto.api.ViewContext: Gets a named object of the given type.
get(String, Class<T>) - Method in interface org.soulwing.prospecto.api.ViewEntity: Gets a property of the entity.
get(String, Object) - Method in interface org.soulwing.prospecto.api.options.Options: Gets the value of the named option.
get(String, Object) - Method in class org.soulwing.prospecto.api.options.OptionsMap
get(T) - Method in interface org.soulwing.prospecto.api.association.ToOneAssociationManager: Gets the current associate.
get(T, int) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
get(T, int) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager
get(T, int) - Method in interface org.soulwing.prospecto.api.association.ToManyIndexedAssociationManager: Gets the associate of the given owner at a specified index.
getAllowedModes() - Method in interface org.soulwing.prospecto.api.template.UpdatableNode: Gets the set of access modes that are allowed by the configuration of this node.
getAssociates(T) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager: Gets the array of associates.
getAssociates(T) - Method in class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager: Gets the collection of associates.
getAssociates(T) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Gets the list of associates.
getAssociateType() - Method in interface org.soulwing.prospecto.api.association.AssociationDescriptor: Gets the class for the model type for the associate.
getAssociationManagers() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the collection of association managers that will be consulted to manage collections in a view during view application.
getComponentType() - Method in interface org.soulwing.prospecto.api.template.ArrayNode: Gets the data type of the elements of this node.
getContext() - Method in class org.soulwing.prospecto.api.listener.ViewNodeEvent: Gets the view context.
getContext() - Method in class org.soulwing.prospecto.api.listener.ViewTraversalEvent: Gets the view context
getDataType() - Method in interface org.soulwing.prospecto.api.template.ValueNode: Gets the data type of the value associated with this node.
getDefaultManager() - Method in interface org.soulwing.prospecto.api.template.ArrayNode: Gets this node's default association manager.
getDefaultManager() - Method in interface org.soulwing.prospecto.api.template.ObjectNode: Gets this node's default association manager.
getElementName() - Method in interface org.soulwing.prospecto.api.template.ArrayNode: Gets the name to use for elements of the array.
getEncoding() - Method in class org.soulwing.prospecto.api.text.InputStreamSource
getEncoding() - Method in class org.soulwing.prospecto.api.text.OutputStreamTarget
getEnvelope() - Method in interface org.soulwing.prospecto.api.View: Deprecated.
getFactory(String) - Static method in class org.soulwing.prospecto.ViewReaderFactoryProducer: Gets a reader factory.
getFactory(String) - Static method in class org.soulwing.prospecto.ViewWriterFactoryProducer: Gets a writer factory.
getFactory(String, Options) - Static method in class org.soulwing.prospecto.ViewReaderFactoryProducer: Gets a reader factory.
getFactory(String, Options) - Static method in class org.soulwing.prospecto.ViewWriterFactoryProducer: Gets a writer factory.
getFormat() - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Gets the format property.
getFormat() - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Gets the format property.
getHandler() - Method in interface org.soulwing.prospecto.api.template.MetaNode: Gets the metadata handler associated with this node.
getHandler() - Method in interface org.soulwing.prospecto.api.template.SpliceNode: Gets the handler to use for this splice.
getInputStream() - Method in class org.soulwing.prospecto.api.text.InputStreamSource
getInstance() - Static method in class org.soulwing.prospecto.api.json.JsonSpliceHandler: Gets the singleton instance of this splice handler type.
getInstance() - Method in class org.soulwing.prospecto.Singleton
getListeners() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the collection of listeners associated with this context.
getMode() - Method in class org.soulwing.prospecto.api.listener.ViewNodeEvent: Gets the mode for which the source node is being considered.
getMode() - Method in class org.soulwing.prospecto.api.listener.ViewTraversalEvent: Gets the view processing mode.
getModel() - Method in class org.soulwing.prospecto.api.listener.ViewNodeEvent: Gets the model associated with the event source node.
getModelClass() - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter: Gets the modelClass property.
getModelType() - Method in interface org.soulwing.prospecto.api.template.ViewNode: Gets the model type associated with this node.
getName() - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy: Gets the name property.
getName() - Method in interface org.soulwing.prospecto.api.template.ViewNode: Gets the name associated with this node.
getName() - Method in interface org.soulwing.prospecto.api.View.Event: Gets the name of the view node associated with this event
getName() - Method in interface org.soulwing.prospecto.spi.ViewReaderFactoryProvider: Gets the provider name (e.g.
getName() - Method in interface org.soulwing.prospecto.spi.ViewWriterFactoryProvider: Gets the provider name (e.g.
getNamespace() - Method in interface org.soulwing.prospecto.api.template.ViewNode: Gets the namespace associated with this node.
getNamespace() - Method in interface org.soulwing.prospecto.api.View.Event: Gets the namespace for name.
getObject(Object) - Method in interface org.soulwing.prospecto.api.template.ObjectNode: Gets the value associated with this node from the given model.
getObjectFactories() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the collection of object factories that will be used as strategies to instantiate model types as needed during view application.
getOptional(Class<T>) - Method in interface org.soulwing.prospecto.api.ViewContext: Gets a singleton object of the given type.
getOptional(String, Class<T>) - Method in interface org.soulwing.prospecto.api.ViewContext: Gets a named object of the given type.
getOptions() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the configuration options associated with this context.
getOptions() - Static method in class org.soulwing.prospecto.ViewOptionsRegistry
getOutputStream() - Method in class org.soulwing.prospecto.api.text.OutputStreamTarget
getOwnerType() - Method in interface org.soulwing.prospecto.api.association.AssociationDescriptor: Gets the class for the model type that owns the association.
getParent() - Method in interface org.soulwing.prospecto.api.template.ViewNode: Gets the parent of this view node.
getPattern() - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Gets the pattern property.
getPattern() - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Gets the pattern property.
getPrefix() - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy: Gets the prefix property.
getPropertyName() - Method in interface org.soulwing.prospecto.api.association.AssociationDescriptor: Gets the property name of the association in the owner type.
getPropertyName() - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter: Gets the propertyName property.
getPropertyName() - Method in interface org.soulwing.prospecto.api.template.UpdatableNode: Gets the name of the updatable property.
getReferenceResolvers() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the collection of reference resolvers that will be consulted to resolve reference objects in a view.
getResolver() - Method in interface org.soulwing.prospecto.spi.UrlResolverProvider: Retrieves the resolver instance.
getResolver() - Static method in class org.soulwing.prospecto.UrlResolverProducer: Creates a new URL resolver.
getRoot(SpliceNode, ViewContext) - Method in class org.soulwing.prospecto.api.splice.ViewGeneratingSpliceHandler: Gets the root model object to use when generating a view.
getScopes() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the collection of scopes that will be consulted when a requested context object is not found in any of the internal scopes managed by the context itself.
getSource() - Method in class org.soulwing.prospecto.api.listener.ViewNodeEvent: Gets the event source.
getSource() - Method in class org.soulwing.prospecto.api.listener.ViewTraversalEvent: Gets the source template for the event.
getSuffix() - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy: Gets the suffix property.
getSupportedModes() - Method in interface org.soulwing.prospecto.api.template.UpdatableNode: Gets the set of access modes that are supported by the model property associated with this node.
getSupportedType() - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Gets the supportedType property.
getTimeZone() - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Gets the timeZone property.
getTimeZone() - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Gets the timeZone property.
getTimeZoneId() - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Gets the ID property of the selected time zone.
getTimeZoneId() - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Gets the ID property of the selected time zone.
getType() - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter
getType() - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter
getType() - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter
getType() - Method in interface org.soulwing.prospecto.api.converter.ValueTypeConverter: Gets the model type understood by this converter.
getType() - Method in interface org.soulwing.prospecto.api.View.Event: Gets the event type.
getType() - Method in interface org.soulwing.prospecto.api.ViewEntity: Gets the data type represented by this entity.
getValue() - Method in class org.soulwing.prospecto.api.discriminator.Discriminator: Gets the value property.
getValue() - Method in class org.soulwing.prospecto.api.listener.ViewNodePropertyEvent: Gets the value property.
getValue() - Method in interface org.soulwing.prospecto.api.template.MetaNode: Gets the (constant) value associated with this node.
getValue() - Method in interface org.soulwing.prospecto.api.View.Event: Gets the value associated with this event.
getValue(Object) - Method in interface org.soulwing.prospecto.api.template.ValueNode: Gets the value associated with this node from the given model.
getValueTypeConverters() - Method in interface org.soulwing.prospecto.api.ViewContext: Gets the collection of ValueTypeConverter instances that will be consulted to convert model value types to view value types and vice-versa.

I

IGNORE_UNKNOWN_PROPERTIES - Static variable in interface org.soulwing.prospecto.api.options.ViewKeys: When set to true a model editor will ignore unknown property names that appear in an input view.
INCLUDE_NULL_PROPERTIES - Static variable in interface org.soulwing.prospecto.api.options.WriterKeys: When set to true a writer will include properties from the view whose value is null.
INCLUDE_XML_XSI_TYPE - Static variable in interface org.soulwing.prospecto.api.options.WriterKeys: When set to true an XML view will include the appropriate xsi:type attribute on each value element.
indexOf(T, ViewEntity, ObjectFactory) - Method in class org.soulwing.prospecto.api.association.AbstractToManyIndexedAssociationManager: Finds the index of the associate of the given owner that is logically equivalent to given view entity.
indexOf(T, ViewEntity, ObjectFactory) - Method in interface org.soulwing.prospecto.api.association.ToManyIndexedAssociationManager: Finds the index of the associate of the given owner that is logically equivalent to given view entity.
init() - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter
init(Map<String, Object>) - Method in interface org.soulwing.prospecto.spi.UrlResolverProvider: Initializes this provider.
init(Map<String, Object>) - Static method in class org.soulwing.prospecto.UrlResolverProducer: Initializes the URL resolver provider.
inject(Object) - Method in interface org.soulwing.prospecto.api.ViewEntity: Injects the properties of this entity onto the given target model object.
InputStreamSource - Class in org.soulwing.prospecto.api.text: A source for a ViewReader that reads to an input stream.
InputStreamSource(InputStream) - Constructor for class org.soulwing.prospecto.api.text.InputStreamSource
InputStreamSource(InputStream, String) - Constructor for class org.soulwing.prospecto.api.text.InputStreamSource
INSTANCE - Static variable in class org.soulwing.prospecto.api.meta.LiteralMetadataHandler
INSTANCE - Static variable in class org.soulwing.prospecto.api.UndefinedValue
isBegin() - Method in enum org.soulwing.prospecto.api.View.Event.Type: Tests whether this is the begin event of a complementary pair.
isDecapitalize() - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy: Gets the decapitalize property.
isEnabled(String) - Method in interface org.soulwing.prospecto.api.options.Options: Tests whether a two-state (boolean) option is set to true.
isEnabled(String) - Method in class org.soulwing.prospecto.api.options.OptionsMap
isEnd() - Method in enum org.soulwing.prospecto.api.View.Event.Type: Tests whether this is the end event of a complementary pair.
ISO8601 - org.soulwing.prospecto.api.converter.DateTypeConverter.Format
ISO8601_DATE - org.soulwing.prospecto.api.converter.DateTypeConverter.Format
ISO8601_TIME - org.soulwing.prospecto.api.converter.DateTypeConverter.Format
ISO8601_WITH_TIME_ZONE - org.soulwing.prospecto.api.converter.DateTypeConverter.Format
isSameAssociate(T, ViewEntity, ObjectFactory) - Method in class org.soulwing.prospecto.api.association.AbstractToOneAssociationManager: Determines whether the given associate entity is logically equivalent to the current associate of the given owner.
isSameAssociate(T, ViewEntity, ObjectFactory) - Method in interface org.soulwing.prospecto.api.association.ToOneAssociationManager: Tests whether the given view entity representing an associate is logically the same object as the owner's current associate.
isSupportSubTypes() - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Gets the supportSubTypes property.
isSupportSubTypes() - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter: Gets the supportSubTypes property.
iterator(Object) - Method in interface org.soulwing.prospecto.api.template.ArrayNode: Gets an iterator for the values associated with this node in the from the given model.
iterator(T) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
iterator(T) - Method in class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager: Gets an iterator for the collection of associates.
iterator(T) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Gets an iterator for the collection of associates.
iterator(T) - Method in interface org.soulwing.prospecto.api.association.ToManyAssociationManager: Gets an iterator for the associated collection.

J

JsonPSource - Class in org.soulwing.prospecto.api.json: A source for a ViewReader that reads a JSON-P structure.
JsonPSource(JsonStructure) - Constructor for class org.soulwing.prospecto.api.json.JsonPSource
JsonPTarget - Class in org.soulwing.prospecto.api.json: A target for a ViewWriter that holds a JSON-P structure.
JsonPTarget() - Constructor for class org.soulwing.prospecto.api.json.JsonPTarget
JsonSpliceHandler - Class in org.soulwing.prospecto.api.json: A SpliceHandler that can be used to embed a JsonStructure into a view.
JsonSpliceHandler.Consumer - Interface in org.soulwing.prospecto.api.json: A consumer interface for a JSON splice node.
JsonSpliceHandler.Producer - Interface in org.soulwing.prospecto.api.json: A producer interface for a JSON splice node.

L

LiteralMetadataHandler - Class in org.soulwing.prospecto.api.meta: A MetadataHandler for literal metadata values.

M

meta(String, Class<? extends MetadataHandler>, Object...) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, Class<? extends MetadataHandler>, Map) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, Object) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, String, Class<? extends MetadataHandler>, Object...) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, String, Class<? extends MetadataHandler>, Map) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, String, Object) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, String, Object, Class<? extends MetadataHandler>, Object...) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, String, Object, Class<? extends MetadataHandler>, Map) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, String, Object, MetadataHandler) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, String, MetadataHandler) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
meta(String, MetadataHandler) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a metadata node at the cursor.
META - org.soulwing.prospecto.api.View.Event.Type
MetadataHandler - Interface in org.soulwing.prospecto.api.meta: A handler for values associated with a MetaNode.
MetaNode - Interface in org.soulwing.prospecto.api.template: A ViewNode that represents a metadata value.
modelType(Class<?>) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter.Builder: Configures the modelClass property.
MutableScope - Interface in org.soulwing.prospecto.api.scope: A mutable Scope.

N

name() - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: For a parent node whose type is an Enum, specifies that a value node should be included for the name of the instance.
name(String) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy.Builder
name(String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: For a parent node whose type is an Enum, specifies that a value node should be included for the name of the instance.
name(String, String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: For a parent node whose type is an Enum, specifies that a value node should be included for the name of the instance.
nameSet() - Method in interface org.soulwing.prospecto.api.ViewEntity: Gets the set of property names that are present in this entity.
navigateTo(String) - Method in interface org.soulwing.prospecto.api.ViewEntity: Navigates this view entity, following the given path, to obtain a reference to a nested view entity.
newAssociate(T, ViewEntity, ObjectFactory) - Method in class org.soulwing.prospecto.api.association.AbstractAssociationManager: Creates an instance of type E and populates it using the state of the given view entity.
newAssociate(T, ViewEntity, ObjectFactory) - Method in interface org.soulwing.prospecto.api.association.AssociationManager: Creates an instance of type E and populates it using the state of the given view entity.
newAssociates() - Method in class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager: Creates a new (empty) associates collection.
newAssociates() - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Creates a new (empty) associates list.
newAssociates(int) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager: Creates a new associates array of the specified size.
newContext() - Static method in class org.soulwing.prospecto.ViewContextProducer: Creates a new view context.
newContext(Options) - Method in interface org.soulwing.prospecto.spi.ViewContextProvider: Creates a new view context.
newContext(Options) - Static method in class org.soulwing.prospecto.ViewContextProducer: Creates a new view context.
newFactory(Options) - Method in interface org.soulwing.prospecto.spi.ViewReaderFactoryProvider: Creates a new factory that will produce readers for the textual representation supported by this provider.
newFactory(Options) - Method in interface org.soulwing.prospecto.spi.ViewWriterFactoryProvider: Creates a new factory that will produce writers for the textual representation supported by this provider.
newInstance() - Method in class org.soulwing.prospecto.Singleton
newInstance(Class<?>) - Method in interface org.soulwing.prospecto.api.factory.ObjectFactory: Creates a new instance of the given type.
newReader(InputStream) - Method in interface org.soulwing.prospecto.api.ViewReaderFactory: Constructs a new reader that will read an input stream as its source.
newReader(ViewReader.Source) - Method in interface org.soulwing.prospecto.api.ViewReaderFactory: Constructs a new reader that will read an arbitrary source.
newScope() - Method in interface org.soulwing.prospecto.api.ViewContext: Creates a new mutable scope.
newWriter(View) - Method in interface org.soulwing.prospecto.api.ViewWriterFactory: Creates a writer that will produce a representation of a view for a target to be specified later.
newWriter(View, OutputStream) - Method in interface org.soulwing.prospecto.api.ViewWriterFactory: Creates a writer that will produce a textual representation of a view on the given output stream.
nodeVisited(ViewNodeEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewNodeListener: Notifies the recipient that a node was visited.
NoSuchProviderException - Exception in org.soulwing.prospecto: An exception thrown to indicate that a service provider was not found.
NoSuchProviderException(String) - Constructor for exception org.soulwing.prospecto.NoSuchProviderException

O

object(Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of object type.
object(String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an object node at the cursor.
object(String, Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of object type.
object(String, String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an object node at the cursor.
object(String, String, Class<?>) - Method in interface org.soulwing.prospecto.spi.ViewTemplateBuilderProvider: Creates a builder for a view whose root node is an object node.
object(String, String, Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of object type.
object(String, String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an object node at the cursor using the root node of the given template.
object(String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds an object node at the cursor using the root node of the given template.
ObjectFactories - Interface in org.soulwing.prospecto.api.factory: A mutable ordered collection of ObjectFactory instances.
ObjectFactory - Interface in org.soulwing.prospecto.api.factory: A factory that provides a strategy for creating model object instances.
ObjectNode - Interface in org.soulwing.prospecto.api.template: A ViewNode representing an object structure.
Options - Interface in org.soulwing.prospecto.api.options: A map-like API for accessing context options.
OptionsMap - Class in org.soulwing.prospecto.api.options: An Options collection implemented on top of a Map.
OptionsMap() - Constructor for class org.soulwing.prospecto.api.options.OptionsMap
org.soulwing.prospecto - package org.soulwing.prospecto: Static producers for various framework components
org.soulwing.prospecto.api - package org.soulwing.prospecto.api: View and View Template API
org.soulwing.prospecto.api.association - package org.soulwing.prospecto.api.association: Association manager API
org.soulwing.prospecto.api.converter - package org.soulwing.prospecto.api.converter: Model type to view type conversion API
org.soulwing.prospecto.api.discriminator - package org.soulwing.prospecto.api.discriminator: Polymorphic type discrimination API
org.soulwing.prospecto.api.factory - package org.soulwing.prospecto.api.factory: Object factory API
org.soulwing.prospecto.api.json - package org.soulwing.prospecto.api.json
org.soulwing.prospecto.api.listener - package org.soulwing.prospecto.api.listener: View node listener API
org.soulwing.prospecto.api.meta - package org.soulwing.prospecto.api.meta: View metadata API
org.soulwing.prospecto.api.options - package org.soulwing.prospecto.api.options: Option configuration for views, view writers, and view readers
org.soulwing.prospecto.api.reference - package org.soulwing.prospecto.api.reference: Reference resolver API
org.soulwing.prospecto.api.scope - package org.soulwing.prospecto.api.scope: Scope API
org.soulwing.prospecto.api.splice - package org.soulwing.prospecto.api.splice
org.soulwing.prospecto.api.template - package org.soulwing.prospecto.api.template: Template and node API
org.soulwing.prospecto.api.text - package org.soulwing.prospecto.api.text
org.soulwing.prospecto.api.url - package org.soulwing.prospecto.api.url: URL resolver API
org.soulwing.prospecto.spi - package org.soulwing.prospecto.spi: Service provider interface
OutputStreamTarget - Class in org.soulwing.prospecto.api.text: A target for a ViewWriter that writes to an output stream.
OutputStreamTarget(OutputStream) - Constructor for class org.soulwing.prospecto.api.text.OutputStreamTarget
OutputStreamTarget(OutputStream, String) - Constructor for class org.soulwing.prospecto.api.text.OutputStreamTarget

P

PATH_DELIMITER - Static variable in interface org.soulwing.prospecto.api.ViewContext: Delimiter used in the string representation of a view path
pattern(String) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter.Builder: Configures the pattern property.
pattern(String) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter.Builder: Configures the pattern property.
PREFIX - Static variable in interface org.soulwing.prospecto.api.options.ViewKeys: Prefix used for all built-in option names.
prepend(AssociationManager) - Method in interface org.soulwing.prospecto.api.association.AssociationManagers: Inserts the given manager such that it becomes the first manager in the collection.
prepend(ValueTypeConverter) - Method in interface org.soulwing.prospecto.api.converter.ValueTypeConverters: Inserts the given converter such that it becomes the first converter in the collection.
prepend(ObjectFactory) - Method in interface org.soulwing.prospecto.api.factory.ObjectFactories: Prepends a factory to the collection.
prepend(ViewListener) - Method in interface org.soulwing.prospecto.api.listener.ViewListeners: Inserts the given listener such that it becomes the first listener in the collection.
prepend(ReferenceResolver) - Method in interface org.soulwing.prospecto.api.reference.ReferenceResolvers: Prepends a resolver to the collection.
prepend(Scope) - Method in interface org.soulwing.prospecto.api.scope.Scopes: Inserts the given scope such that it becomes the first scope in the collection.
prependScope() - Method in interface org.soulwing.prospecto.api.ViewContext: Creates a new mutable scope inserting it at the front of the list of scopes on this context.
PRETTY_PRINT_OUTPUT - Static variable in interface org.soulwing.prospecto.api.options.WriterKeys: When set to true and is supported by the writer, output will be pretty printed.
produceValue(MetaNode, Object, ViewContext) - Method in class org.soulwing.prospecto.api.meta.LiteralMetadataHandler
produceValue(MetaNode, Object, ViewContext) - Method in interface org.soulwing.prospecto.api.meta.MetadataHandler: Produces a value for the given node.
PROPERTY - org.soulwing.prospecto.api.AccessType: use JavaBeans-style accessors
PropertyExtractingValueTypeConverter - Class in org.soulwing.prospecto.api.converter: A converter that extracts a single String, Number, Boolean, Enum, or Date property from a model object.
PropertyExtractingValueTypeConverter() - Constructor for class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter
PropertyExtractingValueTypeConverter.Builder - Class in org.soulwing.prospecto.api.converter: A builder that produces a PropertyExtractingValueTypeConverter.
propertyName(String) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter.Builder: Configures the propertyName property.
propertyVisited(ViewNodePropertyEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewNodePropertyListener: Notifies the recipient that a property was visited.
put(Object) - Method in interface org.soulwing.prospecto.api.scope.MutableScope: Puts an object into this scope.
put(Object) - Method in interface org.soulwing.prospecto.api.ViewContext: Puts an object into the current frame of the context stack.
put(String, Object) - Method in interface org.soulwing.prospecto.api.options.Options: Puts (sets) the value of the named option.
put(String, Object) - Method in class org.soulwing.prospecto.api.options.OptionsMap
put(String, Object) - Method in interface org.soulwing.prospecto.api.scope.MutableScope: Puts a named object into this scope.
put(String, Object) - Method in interface org.soulwing.prospecto.api.ViewContext: Puts a named object into the current frame of the context stack.
put(String, Object) - Method in interface org.soulwing.prospecto.api.ViewEntity: Replaces a property value.
putAll(Iterable<?>) - Method in interface org.soulwing.prospecto.api.scope.MutableScope: Puts a collection of objects into this scope.
putAll(Iterable<?>) - Method in interface org.soulwing.prospecto.api.ViewContext: Puts all of the objects from the given iterable into the current frame of the context stack.
putAll(Map<String, ?>) - Method in interface org.soulwing.prospecto.api.scope.MutableScope: Puts a collection of named objects into this scope.
putAll(Map<String, ?>) - Method in interface org.soulwing.prospecto.api.ViewContext: Puts all of the named objects from the given map into the current frame of the context stack.
putProperty(String, Object) - Method in interface org.soulwing.prospecto.api.View.Envelope: Puts a property onto the envelope.

R

READ - org.soulwing.prospecto.api.AccessMode
ReaderKeys - Interface in org.soulwing.prospecto.api.options: Keys used for configuration options of a ViewReader.
readView() - Method in interface org.soulwing.prospecto.api.ViewReader
reference(Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of reference type.
reference(String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor.
reference(String, Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of reference type.
reference(String, String, Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor.
reference(String, String, Class<?>) - Method in interface org.soulwing.prospecto.spi.ViewTemplateBuilderProvider: Creates a builder for a view whose root node is a reference node.
reference(String, String, Class<?>) - Static method in class org.soulwing.prospecto.ViewTemplateBuilderProducer: Creates a template builder whose root node type is of reference type.
reference(String, String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor using the root node of the given template.
reference(String, ViewTemplate) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a reference object node at the cursor using the root node of the given template.
ReferenceNode - Interface in org.soulwing.prospecto.api.template: A ViewNode representing an object structure where the object is a resolvable reference.
ReferenceResolver - Interface in org.soulwing.prospecto.api.reference: A strategy for resolving a reference entity in a view to an actual object during view application.
ReferenceResolvers - Interface in org.soulwing.prospecto.api.reference: A mutable ordered collection of ReferenceResolver instances.
remove(Object) - Method in interface org.soulwing.prospecto.api.scope.MutableScope: Removes an object from this scope.
remove(Object) - Method in interface org.soulwing.prospecto.api.ViewContext: Removes an object from the current frame of the context stack.
remove(String) - Method in interface org.soulwing.prospecto.api.options.Options: Removes the value of the named options.
remove(String) - Method in class org.soulwing.prospecto.api.options.OptionsMap
remove(String) - Method in interface org.soulwing.prospecto.api.ViewEntity: Removes a property of the entity.
remove(AssociationManager) - Method in interface org.soulwing.prospecto.api.association.AssociationManagers: Removes the given manager from the collection
remove(ValueTypeConverter) - Method in interface org.soulwing.prospecto.api.converter.ValueTypeConverters: Removes the given converter from the collection.
remove(ViewListener) - Method in interface org.soulwing.prospecto.api.listener.ViewListeners: Removes the given listener from the collection.
remove(Scope) - Method in interface org.soulwing.prospecto.api.scope.Scopes: Removes the given scope from the collection.
remove(T, int) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
remove(T, int) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Removes an associate from the list of associates.
remove(T, int) - Method in interface org.soulwing.prospecto.api.association.ToManyIndexedAssociationManager: Removes an associate of the given owner at a specified index.
remove(T, E) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
remove(T, E) - Method in class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager: Removes an associate to the collection of associates.
remove(T, E) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Removes an associate from the list of associates.
remove(T, E) - Method in interface org.soulwing.prospecto.api.association.ToManyAssociationManager: Removes an associate from the collection.
resolve() - Method in interface org.soulwing.prospecto.api.ViewApplicator: Resolves the reference represented by a source view whose root is of reference type.
resolve(Class<?>, ViewEntity) - Method in interface org.soulwing.prospecto.api.reference.ReferenceResolver: Resolves the given reference entity to an actual object instance of the type represented by the reference.
resolve(ViewNode, ViewContext) - Method in interface org.soulwing.prospecto.api.url.UrlResolver: Resolves a URL string for a view node of type url.
resolveAll() - Method in interface org.soulwing.prospecto.api.ViewApplicator: Resolves all of the references represented by a source view whose root is an array of references.
RFC1123 - org.soulwing.prospecto.api.converter.DateTypeConverter.Format

S

Scope - Interface in org.soulwing.prospecto.api.scope: An object that acts as a container for other objects and supports retrieval by type and by name.
Scopes - Interface in org.soulwing.prospecto.api.scope: A mutable ordered collection of Scope instances.
seal(String) - Method in interface org.soulwing.prospecto.api.View.Envelope: Encapsulates the view associated with this envelope in another view.
seal(String, String) - Method in interface org.soulwing.prospecto.api.View.Envelope: Encapsulates the view associated with this envelope in another view.
set(T, int, E) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
set(T, int, E) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager
set(T, int, E) - Method in interface org.soulwing.prospecto.api.association.ToManyIndexedAssociationManager: Sets (replaces) the associate of the given owner at a specified index.
set(T, E) - Method in interface org.soulwing.prospecto.api.association.ToOneAssociationManager: Sets the current associate.
setAssociates(T, E[]) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager: Sets the array of associates.
setAssociates(T, Collection<E>) - Method in class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager: Sets the collection of associates.
setAssociates(T, List<E>) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Sets the list of associates.
setDecapitalize(boolean) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy: Sets the decapitalize property.
setFormat(DateTypeConverter.Format) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Sets the format property.
setFormat(DateTypeConverter.Format) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Sets the format property.
setModelClass(Class<?>) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter: Sets the modelClass property.
setName(String) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy: Sets the name property.
setPattern(String) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Sets the pattern property.
setPattern(String) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Sets the pattern property.
setPrefix(String) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy: Sets the prefix property.
setPropertyName(String) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter: Sets the propertyName property.
setSuffix(String) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy: Sets the suffix property.
setSupportedType(Class<? extends Date>) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Sets the supportedType property.
setSupportSubTypes(boolean) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Sets the supportSubTypes property.
setSupportSubTypes(boolean) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter: Sets the supportSubTypes property.
setTimeZone(TimeZone) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Sets the timeZone property.
setTimeZone(TimeZone) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Sets the timeZone property.
setTimeZoneId(String) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter: Sets the timeZone property to the zone that corresponds to the given ID.
setTimeZoneId(String) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter: Sets the timeZone property to the zone that corresponds to the given ID.
setValue(Object, Object) - Method in interface org.soulwing.prospecto.api.template.UpdatableValueNode: Sets the value associated with this node in the given model.
shouldVisitNode(ViewNodeEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewNodeAcceptor: Notifies the recipient that a view node will be visited.
SimpleClassNameDiscriminatorStrategy - Class in org.soulwing.prospecto.api.discriminator: A DiscriminatorStrategy that utilizes the simple (unqualified) class name.
SimpleClassNameDiscriminatorStrategy() - Constructor for class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy
SimpleClassNameDiscriminatorStrategy.Builder - Class in org.soulwing.prospecto.api.discriminator: A builder that produces a SimpleClassNameDiscriminatorStrategy instance.
Singleton<T> - Class in org.soulwing.prospecto: A factory that produces a singleton instance of a given type.
Singleton() - Constructor for class org.soulwing.prospecto.Singleton
size(T) - Method in class org.soulwing.prospecto.api.association.AbstractArrayAssociationManager
size(T) - Method in class org.soulwing.prospecto.api.association.AbstractCollectionAssociationManager: Gets the size of the collection of associates.
size(T) - Method in class org.soulwing.prospecto.api.association.AbstractListAssociationManager: Gets the size of the collection of associates.
size(T) - Method in interface org.soulwing.prospecto.api.association.ToManyAssociationManager: Gets the size of the associated collection.
source(String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies the name of the model property that is the source for the node at the cursor.
splice(String, Class<? extends SpliceHandler>, Object...) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a splice node at the cursor.
splice(String, Class<? extends SpliceHandler>, Map) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a splice node at the cursor.
splice(String, String, Class<? extends SpliceHandler>, Object...) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a splice node at the cursor.
splice(String, String, Class<? extends SpliceHandler>, Map) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a splice node at the cursor.
splice(String, String, SpliceHandler) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a splice node at the cursor.
splice(String, SpliceHandler) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a splice node at the cursor.
SpliceHandler - Interface in org.soulwing.prospecto.api.splice: An handler for a view splice.
SpliceNode - Interface in org.soulwing.prospecto.api.template: A ViewNode representing the splicing of a separate view generation/application processing operation.
Stateful - Interface in org.soulwing.prospecto.api.association: An instance of an AssociationManager that implements this interface is cloned before it is used to perform a management operation.
store(JsonStructure) - Method in class org.soulwing.prospecto.api.json.JsonPTarget
stripPrefix(String) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy.Builder
stripSuffix(String) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy.Builder
subtype(Class<?>) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Introduces a subtype of the type associated with the current object or array-of-objects node.
SubtypeNode - Interface in org.soulwing.prospecto.api.template: A ViewNode that represents a subtype.
supportedType(Class<? extends Date>) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter.Builder: Configures the supportedType property.
supports(Class<?>) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter
supports(Class<?>) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter
supports(Class<?>) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter
supports(Class<?>) - Method in interface org.soulwing.prospecto.api.converter.ValueTypeConverter: Tests whether this converter supports a given model type.
supports(Class<?>) - Method in interface org.soulwing.prospecto.api.reference.ReferenceResolver: Determines whether this resolver supports the given model type.
supports(AssociationDescriptor) - Method in interface org.soulwing.prospecto.api.association.AssociationManager: Tests whether this manager supports a given association.
supportSubTypes(boolean) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter.Builder: Configures the supportSubTypes property.
supportSubTypes(boolean) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter.Builder: Configures the supportSubTypes property.

T

timeZone(TimeZone) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter.Builder: Configures the timeZone property.
timeZone(TimeZone) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter.Builder: Configures the timeZone property.
timeZoneId(String) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter.Builder: Configures the timeZoneId property.
timeZoneId(String) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter.Builder: Configures the timeZoneId property.
TO_STRING_NODE_NAME - Static variable in interface org.soulwing.prospecto.api.options.ViewDefaults: Default name for a Object.toString() value node.
toDiscriminator(Class<?>, Class<?>) - Method in interface org.soulwing.prospecto.api.discriminator.DiscriminatorStrategy: Produces a discriminator for the given subtype of a base type.
toDiscriminator(Class<?>, Class<?>) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy
toDiscriminator(Class<?>, Class<?>) - Method in class org.soulwing.prospecto.api.discriminator.UnqualifiedClassNameDiscriminatorStrategy
toJson() - Method in class org.soulwing.prospecto.api.json.JsonPSource
toJson() - Method in class org.soulwing.prospecto.api.json.JsonPTarget
toList() - Method in interface org.soulwing.prospecto.api.association.AssociationManagers: Coerces this collection into a list.
toList() - Method in interface org.soulwing.prospecto.api.converter.ValueTypeConverters: Coerces this collection into a list.
toList() - Method in interface org.soulwing.prospecto.api.factory.ObjectFactories: Coerces this collection to a List.
toList() - Method in interface org.soulwing.prospecto.api.listener.ViewListeners: Coerces this collection into a list.
toList() - Method in interface org.soulwing.prospecto.api.reference.ReferenceResolvers: Coerces this collection to a List.
toList() - Method in interface org.soulwing.prospecto.api.scope.Scopes: Coerces this collection into a list.
ToManyAssociationManager<T,E> - Interface in org.soulwing.prospecto.api.association: An object that during view application manages the association between an object and a collection composed in the object.
ToManyIndexedAssociationManager<T,E> - Interface in org.soulwing.prospecto.api.association: An object that during view application manages the association between an object and a indexed collection or array composed in the object.
toMap() - Method in interface org.soulwing.prospecto.api.options.Options: Coerces this options collection to a map.
toMap() - Method in class org.soulwing.prospecto.api.options.OptionsMap
toModelValue(Object, ViewContext) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter
toModelValue(Object, ViewContext) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter
toModelValue(Object, ViewContext) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter
toModelValue(Object, ViewContext) - Method in interface org.soulwing.prospecto.api.converter.ValueTypeConverter: Converts a value from a view into a model object.
ToOneAssociationManager<T,E> - Interface in org.soulwing.prospecto.api.association: An object that during view application manages the association between an object and an associated object.
toString() - Method in class org.soulwing.prospecto.api.discriminator.Discriminator
toStringValue() - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies that a value node should be included for the Object.toString() value of parent node.
toStringValue(String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies that a value node should be included for the Object.toString() value of parent node.
toStringValue(String, String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Specifies that a value node should be included for the Object.toString() value of parent node.
toSubtype(Class<T>, Discriminator) - Method in interface org.soulwing.prospecto.api.discriminator.DiscriminatorStrategy: Determines the subtype that corresponds to a given discriminator.
toSubtype(Class<T>, Discriminator) - Method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy
toSubtype(Class<T>, Discriminator) - Method in class org.soulwing.prospecto.api.discriminator.UnqualifiedClassNameDiscriminatorStrategy
toValueOfType(Class<T>, Object) - Static method in class org.soulwing.prospecto.api.converter.Coerce: Coerces a view value to a model value type.
toViewEntity() - Method in interface org.soulwing.prospecto.api.ViewApplicator: Produces an view entity representation for this applicator.
toViewValue(Object, ViewContext) - Method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter
toViewValue(Object, ViewContext) - Method in class org.soulwing.prospecto.api.converter.DateTypeConverter
toViewValue(Object, ViewContext) - Method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter
toViewValue(Object, ViewContext) - Method in interface org.soulwing.prospecto.api.converter.ValueTypeConverter: Converts a model object (generally of a simple type) to a suitable representation for a view node of value type.
traverse(ViewNodeVisitor, Object) - Method in interface org.soulwing.prospecto.api.ViewTemplate.Traversal: Performs a traversal.

U

UndefinedValue - Class in org.soulwing.prospecto.api: A value that is used to represent a missing or disallowed value during model update.
UnqualifiedClassNameDiscriminatorStrategy - Class in org.soulwing.prospecto.api.discriminator: A discriminator that uses the unqualified class name and takes one level of class nesting into account.
UnqualifiedClassNameDiscriminatorStrategy() - Constructor for class org.soulwing.prospecto.api.discriminator.UnqualifiedClassNameDiscriminatorStrategy
UnresolvedUrlException - Exception in org.soulwing.prospecto.api.url: An exception thrown when a UrlResolver fails to resolve a model path into a URL.
UnresolvedUrlException(String) - Constructor for exception org.soulwing.prospecto.api.url.UnresolvedUrlException
UnresolvedUrlException(String, Throwable) - Constructor for exception org.soulwing.prospecto.api.url.UnresolvedUrlException
UnresolvedUrlException(Throwable) - Constructor for exception org.soulwing.prospecto.api.url.UnresolvedUrlException
UpdatableNode - Interface in org.soulwing.prospecto.api.template: A ViewNode that can be used to update a corresponding model value.
UpdatableValueNode - Interface in org.soulwing.prospecto.api.template: A ValueNode that can be used to update a property of a model.
update(Object) - Method in interface org.soulwing.prospecto.api.ViewApplicator: Updates the given model by injecting it with the properties represented in the source view.
update(Object[], ToManyIndexedAssociationManager<?, ?>) - Method in interface org.soulwing.prospecto.api.ViewApplicator: Updates the given array of model objects with the state represented in a source view whose root is an array of objects.
update(Collection<?>, ToManyAssociationManager<?, ?>) - Method in interface org.soulwing.prospecto.api.ViewApplicator: Updates the given collection of model objects with the state represented in a source view whose root is an array of objects.
update(List<?>, ToManyIndexedAssociationManager<?, ?>) - Method in interface org.soulwing.prospecto.api.ViewApplicator: Updates the given list of model objects with the state represented in a source view whose root is an array of objects.
url() - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a URL node at the cursor.
url(String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a URL node at the cursor.
url(String, String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a URL node at the cursor.
URL_NAME - Static variable in interface org.soulwing.prospecto.api.options.ReaderKeys: URL property name.
URL_NODE_NAME - Static variable in interface org.soulwing.prospecto.api.options.ViewDefaults: Default name for a URL node.
UrlResolver - Interface in org.soulwing.prospecto.api.url: A service that resolve the actual URL string for a value node of type url.
UrlResolverProducer - Class in org.soulwing.prospecto: A singleton object that produces UrlResolver instances.
UrlResolverProvider - Interface in org.soulwing.prospecto.spi: A provider for a UrlResolver.

V

value(String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a value node at the cursor.
value(String, String) - Method in interface org.soulwing.prospecto.api.ViewTemplateBuilder: Adds a value node at the cursor.
VALUE - org.soulwing.prospecto.api.View.Event.Type
ValueNode - Interface in org.soulwing.prospecto.api.template: A ViewNode representing a simple value.
valueOf(String) - Static method in enum org.soulwing.prospecto.api.AccessMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.soulwing.prospecto.api.AccessType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.soulwing.prospecto.api.converter.DateTypeConverter.Format: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.soulwing.prospecto.api.listener.ViewMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.soulwing.prospecto.api.View.Event.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.soulwing.prospecto.api.AccessMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.soulwing.prospecto.api.AccessType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.soulwing.prospecto.api.converter.DateTypeConverter.Format: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.soulwing.prospecto.api.listener.ViewMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.soulwing.prospecto.api.View.Event.Type: Returns an array containing the constants of this enum type, in the order they are declared.
ValueTypeConverter - Interface in org.soulwing.prospecto.api.converter: A converter that transforms simple model objects into a suitable representation for a view node of value type and vice-versa.
ValueTypeConverters - Interface in org.soulwing.prospecto.api.converter: A mutable ordered collection of ValueTypeConverters.
View - Interface in org.soulwing.prospecto.api: A view is a hierarchical organization of selected information from a model.
View.Envelope - Interface in org.soulwing.prospecto.api: An envelope for a view.
View.Event - Interface in org.soulwing.prospecto.api: An event for a view.
View.Event.Type - Enum in org.soulwing.prospecto.api: Event type
ViewApplicator - Interface in org.soulwing.prospecto.api: An applicator for a view.
ViewApplicatorException - Exception in org.soulwing.prospecto.api: An exception thrown by a ViewApplicator.
ViewApplicatorException() - Constructor for exception org.soulwing.prospecto.api.ViewApplicatorException
ViewApplicatorException(String) - Constructor for exception org.soulwing.prospecto.api.ViewApplicatorException
ViewApplicatorException(String, Throwable) - Constructor for exception org.soulwing.prospecto.api.ViewApplicatorException
ViewApplicatorException(Throwable) - Constructor for exception org.soulwing.prospecto.api.ViewApplicatorException
ViewContext - Interface in org.soulwing.prospecto.api: A context used when evaluating view template with a model to produce a view.
ViewContextProducer - Class in org.soulwing.prospecto: A singleton object that produces ViewContext instances.
ViewContextProvider - Interface in org.soulwing.prospecto.spi: A ViewContext provider.
ViewDefaults - Interface in org.soulwing.prospecto.api.options: Default values for various view options.
ViewEntity - Interface in org.soulwing.prospecto.api: An abstract entity in a view.
ViewEvent - Interface in org.soulwing.prospecto.api.listener: A marker that identifies an event for a ViewListener.
ViewException - Exception in org.soulwing.prospecto.api: An exception thrown if the evaluation of a view fails.
ViewException(String) - Constructor for exception org.soulwing.prospecto.api.ViewException
ViewException(String, Throwable) - Constructor for exception org.soulwing.prospecto.api.ViewException
ViewException(Throwable) - Constructor for exception org.soulwing.prospecto.api.ViewException
ViewGeneratingSpliceHandler - Class in org.soulwing.prospecto.api.splice: A splice handler that generates a view using a ViewTemplate provided as a node attribute.
ViewGeneratingSpliceHandler() - Constructor for class org.soulwing.prospecto.api.splice.ViewGeneratingSpliceHandler
ViewInputException - Exception in org.soulwing.prospecto.api: An exception thrown when processing the contents of a view as input in a ViewApplicator.
ViewInputException() - Constructor for exception org.soulwing.prospecto.api.ViewInputException
ViewInputException(String) - Constructor for exception org.soulwing.prospecto.api.ViewInputException
ViewInputException(String, Throwable) - Constructor for exception org.soulwing.prospecto.api.ViewInputException
ViewInputException(Throwable) - Constructor for exception org.soulwing.prospecto.api.ViewInputException
ViewKeys - Interface in org.soulwing.prospecto.api.options: Keys for view configuration options.
ViewListener - Interface in org.soulwing.prospecto.api.listener: Marker interface that identifies a listener type.
ViewListeners - Interface in org.soulwing.prospecto.api.listener: A mutable ordered collection of ViewListener instances.
ViewMode - Enum in org.soulwing.prospecto.api.listener: An enumeration of modes in which a view is processed.
ViewNode - Interface in org.soulwing.prospecto.api.template: A node in a view hierarchy.
ViewNodeAcceptor - Interface in org.soulwing.prospecto.api.listener: A listener that is notified before nodes are visited during a view processing lifecycle.
ViewNodeEntityListener - Interface in org.soulwing.prospecto.api.listener: A listener that is notified as instances of model types are created or discarded during view application.
ViewNodeEvent - Class in org.soulwing.prospecto.api.listener: An event about a view node.
ViewNodeEvent(ViewMode, ViewNode, Object, ViewContext) - Constructor for class org.soulwing.prospecto.api.listener.ViewNodeEvent: Constructs a new instance.
ViewNodeListener - Interface in org.soulwing.prospecto.api.listener: An listener that is notified as nodes are visited during view generation or view application.
ViewNodePropertyEvent - Class in org.soulwing.prospecto.api.listener: An event that describes a property of a view node.
ViewNodePropertyEvent(ViewMode, ViewNode, Object, Object, ViewContext) - Constructor for class org.soulwing.prospecto.api.listener.ViewNodePropertyEvent: Constructs a new instance.
ViewNodePropertyEvent(ViewNodePropertyEvent, Object) - Constructor for class org.soulwing.prospecto.api.listener.ViewNodePropertyEvent: Constructs a copy of an event, composed with a different property model.
ViewNodePropertyInterceptor - Interface in org.soulwing.prospecto.api.listener: An interceptor that is notified as property values are visited during view generation or view application.
ViewNodePropertyListener - Interface in org.soulwing.prospecto.api.listener: An listener that is notified as properties are visited during view generation or view application.
ViewNodeVisitor - Interface in org.soulwing.prospecto.api.template: A visitor for a ViewNode.
ViewOptionsRegistry - Class in org.soulwing.prospecto: A static registry for view options.
ViewOptionsRegistry() - Constructor for class org.soulwing.prospecto.ViewOptionsRegistry
ViewPostTraversalListener - Interface in org.soulwing.prospecto.api.listener: A listener that is notified after a view template is traversed to generate or apply a view.
ViewPreTraversalListener - Interface in org.soulwing.prospecto.api.listener: A listener that is notified before a view template is traversed to generate or apply a view.
ViewReader - Interface in org.soulwing.prospecto.api: A reader for a view.
ViewReader.Source - Interface in org.soulwing.prospecto.api
ViewReaderFactory - Interface in org.soulwing.prospecto.api: A factory that produces ViewReader objects.
ViewReaderFactoryProducer - Class in org.soulwing.prospecto: A singleton object that produces ViewReaderFactory instances.
ViewReaderFactoryProvider - Interface in org.soulwing.prospecto.spi: A provider for a ViewReaderFactory.
ViewTemplate - Interface in org.soulwing.prospecto.api: A view template.
ViewTemplate.Traversal - Interface in org.soulwing.prospecto.api: A traversal for a ViewTemplate.
ViewTemplateBuilder - Interface in org.soulwing.prospecto.api: A builder for a ViewTemplate.
ViewTemplateBuilderProducer - Class in org.soulwing.prospecto: A singleton object that produces ViewTemplateBuilder instances.
ViewTemplateBuilderProvider - Interface in org.soulwing.prospecto.spi: A ViewTemplateBuilder provider.
ViewTemplateException - Exception in org.soulwing.prospecto.api: An exception thrown when building a ViewTemplate.
ViewTemplateException(String) - Constructor for exception org.soulwing.prospecto.api.ViewTemplateException
ViewTemplateException(String, Throwable) - Constructor for exception org.soulwing.prospecto.api.ViewTemplateException
ViewTemplateException(Throwable) - Constructor for exception org.soulwing.prospecto.api.ViewTemplateException
ViewTraversalEvent - Class in org.soulwing.prospecto.api.listener: An event that describes a view traversal.
ViewTraversalEvent(ViewMode, ViewTemplate, ViewContext) - Constructor for class org.soulwing.prospecto.api.listener.ViewTraversalEvent: Constructs a new instance.
ViewWriter - Interface in org.soulwing.prospecto.api: A writer for a view.
ViewWriter.Target - Interface in org.soulwing.prospecto.api
ViewWriterFactory - Interface in org.soulwing.prospecto.api: A factory that produces ViewWriter instances.
ViewWriterFactoryProducer - Class in org.soulwing.prospecto: A singleton object that produces ViewWriterFactory instances.
ViewWriterFactoryProvider - Interface in org.soulwing.prospecto.spi: A provider for a ViewWriterFactory.
visitArrayOfObjects(ArrayOfObjectsNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitArrayOfObjects(ArrayOfObjectsNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits an array-of-objects node.
visitArrayOfReferences(ArrayOfReferencesNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitArrayOfReferences(ArrayOfReferencesNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits an array-of-references node.
visitArrayOfValues(ArrayOfValuesNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitArrayOfValues(ArrayOfValuesNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits an array-of-values node.
visitEnvelope(EnvelopeNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitEnvelope(EnvelopeNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits an envelope node.
visitMeta(MetaNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitMeta(MetaNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits a metadata node.
visitObject(ObjectNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitObject(ObjectNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits an object node.
visitReference(ReferenceNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitReference(ReferenceNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits a reference node.
visitSplice(SpliceNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitSplice(SpliceNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits a splice node.
visitSubtype(SubtypeNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitSubtype(SubtypeNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits a subtype node.
visitValue(ValueNode, Object) - Method in class org.soulwing.prospecto.api.template.AbstractViewNodeVisitor
visitValue(ValueNode, Object) - Method in interface org.soulwing.prospecto.api.template.ViewNodeVisitor: Visits a value node.

W

willInjectValue(ViewNodePropertyEvent) - Method in interface org.soulwing.prospecto.api.listener.ViewNodePropertyInterceptor: Notifies the recipient that a value will be injected into a model from a view node associated with a view.
with() - Static method in class org.soulwing.prospecto.api.converter.CalendarTypeConverter.Builder: Constructs a new instance.
with() - Static method in class org.soulwing.prospecto.api.converter.DateTypeConverter.Builder: Constructs a new instance.
with() - Static method in class org.soulwing.prospecto.api.converter.PropertyExtractingValueTypeConverter.Builder: Creates a new builder instance.
with() - Static method in class org.soulwing.prospecto.api.discriminator.SimpleClassNameDiscriminatorStrategy.Builder
WRAP_ARRAY_IN_ENVELOPE - Static variable in interface org.soulwing.prospecto.api.options.WriterKeys: When set to false a view whose root is of array type will not be wrapped in an envelope.
WRAP_OBJECT_IN_ENVELOPE - Static variable in interface org.soulwing.prospecto.api.options.WriterKeys: When set to true a view whose root is of object type will be wrapped in an envelope if the root element is named.
WRITE - org.soulwing.prospecto.api.AccessMode
WriterKeys - Interface in org.soulwing.prospecto.api.options: Keys used for configuration options of a ViewWriter.
writeView() - Method in interface org.soulwing.prospecto.api.ViewWriter
writeView(ViewWriter.Target) - Method in interface org.soulwing.prospecto.api.ViewWriter

A B C D E F G I J L M N O P R S T U V W
All Classes All Packages