ListField.java

// <editor-fold defaultstate="collapsed" desc="license">
/*
 * Copyright (c) 2014, Karl H. Beckers
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * * Neither the name of the <ORGANIZATION> nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 **/
// </editor-fold>
package net.jarre_de_the.griffin.types.field;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.io.RandomAccessFile;
import java.util.List;
import net.jarre_de_the.griffin.file.Gff;
import net.jarre_de_the.griffin.types.data.DWordData;
import net.jarre_de_the.griffin.types.data.ListData;
import net.jarre_de_the.griffin.types.data.StructData;

/**
 *
 * @author charly4711
 */
public class ListField
        extends BaseComplexField
        implements Cloneable {

    /*
     *
     * constructors
     *
     */
    public ListField() {
        super(FieldType.List, new ListData());
    }

    public ListField(byte[] label,
                     ListData d) {
        super(FieldType.List, d);
        setLabel(label);
    }

    public ListField(RandomAccessFile in,
                     Gff file)
            throws IOException {
        super(in, file, ListData.class);
    }

    /*
     *
     * read / write
     *
     */
    @Override
    public void persist(ByteArrayOutputStream structArray,
                        ByteArrayOutputStream fieldArray,
                        List labelArrayList,
                        ByteArrayOutputStream fieldIndicesArray,
                        ByteArrayOutputStream listIndicesArray,
                        ByteArrayOutputStream fieldData)
            throws IOException {

        // buffer for the field itself
        DWordData fBuf[] = persistTypeAndLabel(labelArrayList);
        // data pointer
        fBuf[2] = new DWordData(listIndicesArray.size());

        // first persist the field
        for (DWordData d : fBuf) {
            fieldArray.write(d.getValueAsByteArray());
        }

        // data buffer
        ListData l = getValue();
        if (null != l) {
            List<StructData> structs = l.getValueAsList();
            if (structs == null) {
                listIndicesArray.write(new DWordData(0).getValueAsByteArray());
            } else {
                listIndicesArray.write(new DWordData(structs.size()).
                        getValueAsByteArray());

                // the same fixing as below for the field index array is
                // required for the list index array
                ByteArrayOutputStream preListIdx = new ByteArrayOutputStream();
                preListIdx.write(listIndicesArray.toByteArray());
                for (StructData s : structs) {
                    listIndicesArray.write(new DWordData(0).getValueAsByteArray());
                }

                // fist persist the structs
                for (StructData s : structs) {
                    preListIdx.write(new DWordData(structArray.size()
                            / StructData.STRUCT_LENGTH).getValueAsByteArray());

                    structArray.write(s.getId().getValueAsByteArray());

                    List<AbstractField> fields = s.getValueAsList();
                    if (fields == null || fields.isEmpty()) {
                        structArray.write(new DWordData(0).getValueAsByteArray());
                        structArray.write(new DWordData(0).getValueAsByteArray());
                    } else if (fields.size() == 1) {
                        structArray.write(new DWordData(fieldArray.size() / AbstractField.FIELD_LENGTH).
                                getValueAsByteArray());
                        structArray.write(new DWordData(1).getValueAsByteArray());

                        fields.get(0).persist(structArray, fieldArray,
                                              labelArrayList,
                                              fieldIndicesArray, listIndicesArray, fieldData);
                    } else {
                        structArray.write(new DWordData(fieldIndicesArray.size()).
                                getValueAsByteArray());
                        structArray.write(new DWordData(fields.size()).
                                getValueAsByteArray());

                        // save the current state
                        ByteArrayOutputStream pre = new ByteArrayOutputStream();
                        pre.write(fieldIndicesArray.toByteArray());

                        for (AbstractField f : fields) {
                            // because I have put the pointer into the field index
                            // array into the struct above, I now need to make sure
                            // nobody else writes to the field index array before
                            // we complete.
                            // (If I hadn't done that above, I would have the same
                            // problem with the struct array)
                            // Now, we cannot prevent that, so we need to correct the
                            // field index array later on ... first we write some
                            // dummy entries
                            fieldIndicesArray.write(new DWordData(0).
                                    getValueAsByteArray());
                        }

                        for (AbstractField f : fields) {
                            DWordData fieldIdx = new DWordData(fieldArray.size()
                                    / FIELD_LENGTH);
                            f.persist(structArray, fieldArray, labelArrayList,
                                      fieldIndicesArray, listIndicesArray, fieldData);
                            // add to the pre state
                            pre.write(fieldIdx.getValueAsByteArray());
                        }

                        // fix the field index array
                        byte[] post = fieldIndicesArray.toByteArray();
                        fieldIndicesArray.reset();
                        fieldIndicesArray.write(pre.toByteArray());

                        int preLength = pre.toByteArray().length;
                        fieldIndicesArray.write(post, preLength, post.length
                                                - preLength);
                    }
                }

                // fix the list index array
                byte[] postListIdx = listIndicesArray.toByteArray();
                listIndicesArray.reset();
                listIndicesArray.write(preListIdx.toByteArray());

                int preListIdxLength = preListIdx.toByteArray().length;
                listIndicesArray.write(postListIdx, preListIdxLength,
                                       postListIdx.length - preListIdxLength);
            }
        }
    }

    /*
     *
     * getter
     *
     */
    @Override
    public ListData getValue() {
        return (ListData) getData();
    }

    /*
     *
     * utility
     *
     */
    @Override
    public void printString(PrintStream out,
                            int align) {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < align; i++) {
            sb.append(" ");
        }
        sb.append(this.toString());
        out.println(sb.toString());

        align++;
        List<StructData> l = this.getValue().getValueAsList();
        for (StructData s : l) {
            List<AbstractField> fl = s.getValueAsList();
            for (AbstractField f : fl) {
                f.printString(out, align);
            }
        }
        align--;
    }

    @Override
    public ListField clone() throws CloneNotSupportedException {
        ListField clone = (ListField) super.clone();
        // because ListData is not immutable and getValue() returns the
        // actual list, we need to clone, manually, here.
        clone.setData(getValue().clone());
        return clone;
    }
}