Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.hivemind.schema
Interface Translator  view Translator download Translator.java


public interface Translator

Object which can translate a string into an object value. This is used to translate attribute values (or element content) from strings into numbers, booleans or other constructs before assigning the final value to a propery. Translation occurs after symbol substitution.

Translator classes should have a public constructor that takes no arguments. They may optionally have a second constructor that takes a single string as a parameter. When the org.apache.hivemind.parse.DescriptorParser encounters a translator of the form "translator-id,initialization-string" (example: "int,min=0") it will use the second constructor, passing the initialization string.

Generally, initializion strings are of the form key=value[,key=value]*. Each initializer has a set of keys it recognizes, other keys are simply ignored.


Method Summary
 java.lang.Object translate(org.apache.hivemind.internal.Module contributingModule, java.lang.Class propertyType, java.lang.String inputValue, org.apache.hivemind.Location location)
          Invoked by a Rule to translate an inputValue into an appropriate object.
 

Method Detail

translate

public java.lang.Object translate(org.apache.hivemind.internal.Module contributingModule,
                                  java.lang.Class propertyType,
                                  java.lang.String inputValue,
                                  org.apache.hivemind.Location location)
Invoked by a Rule to translate an inputValue into an appropriate object. Substitution symbols will already have been expanded before this method is invoked.