| /* |
| * Copyright 2009-2010 by The Regents of the University of California |
| * 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 from |
| * |
| * 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 edu.uci.ics.hyracks.api.dataflow.value; |
| |
| import java.io.Serializable; |
| |
| import edu.uci.ics.hyracks.api.comm.IFrameTupleAccessor; |
| import edu.uci.ics.hyracks.api.exceptions.HyracksDataException; |
| |
| public interface IResultSerializer extends Serializable { |
| /** |
| * Initializes the serializer. |
| */ |
| public void init() throws HyracksDataException; |
| |
| /** |
| * Method to serialize the result and append it to the provided output stream |
| * |
| * @param tAccess |
| * - A frame tuple accessor object that contains the original data to be serialized |
| * @param tIdx |
| * - Index of the tuple that should be serialized. |
| * @return true if the tuple was appended successfully, else false. |
| */ |
| public boolean appendTuple(IFrameTupleAccessor tAccess, int tIdx) throws HyracksDataException; |
| } |