org.ujoframework.extensions.UjoTextable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ujo-orm Show documentation

Quick ORM implementation based on the UJO objects.

There is a newer version: 1.22

/*
 *  Copyright 2007-2010 Pavel Ponec
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */   

package org.ujoframework.extensions;

import org.ujoframework.UjoAction;
import org.ujoframework.Ujo;
import org.ujoframework.UjoProperty;

/**
 * The interface is reasonable for a text serialization and deserializaton of non UJO properties of a UJO object.
 * 
If you can use an UJO persistence (XML, CSV, ResourceBundle) then the all affected UJO classes must have got next features:
 * 
 *   no parameter constructor and
 *   non UJO properties must have got a features of ValueTextable *
 *   property type of List must be implemented by a UjoPropertyList implementation (only XML persistence supports the one)
 * 
 * 
 * @see ValueTextable See ValueTextable for suppored data types.
 * @author Pavel Ponec
 */
public interface UjoTextable extends Ujo {
    
    /**
     * Set value from a String format. Property can't be an "container" type (Ujo, List, Object[]).
     * 
     * @param property A direct property only. See a method UjoProperty.isDirect().
     * @param value String value
     * @param type Type can be a subtype of a Property.type. If type is null, then a property.type is used.
     * @param action A context of the action.
     *        The action must not be null, however there is allowed to use a dummy constant UjoAction.DUMMY .
     */
    public void writeValueString(UjoProperty property, String value, Class type, UjoAction action);
    
    /**
     * Get an original value in a String format. If property type is a "container" type (Ujo, List, Object[]), method returns null,
     * otherwise method returns an instance of String.
     * 
     * @param property A direct property only. See a method UjoProperty.isDirect().
     * @param action A context of the action.
     *        The action must not be null, however there is allowed to use a dummy constant UjoAction.DUMMY .
     * @return If property type is "container" result is null.
     */
    public String readValueString(UjoProperty property, UjoAction action);
    
}