hivemall.smile.data.Attribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemall-all
There is a newer version: 0.6.0-incubating
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 hivemall.smile.data;

import hivemall.annotations.BackwardCompatibility;
import hivemall.annotations.Immutable;
import hivemall.annotations.Mutable;

import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

public abstract class Attribute {

    public final AttributeType type;

    Attribute(AttributeType type) {
        this.type = type;
    }

    public void setSize(int size) {
        throw new UnsupportedOperationException();
    }

    /**
     * @return -1 if not set
     */
    public int getSize() {
        throw new UnsupportedOperationException();
    }

    public void writeTo(ObjectOutput out) throws IOException {
        out.writeByte(type.getTypeId());
    }

    public enum AttributeType {
        NUMERIC((byte) 1), NOMINAL((byte) 2);

        private final byte id;

        private AttributeType(byte id) {
            this.id = id;
        }

        public byte getTypeId() {
            return id;
        }

        public static AttributeType resolve(byte id) {
            final AttributeType type;
            switch (id) {
                case 1:
                    type = NUMERIC;
                    break;
                case 2:
                    type = NOMINAL;
                    break;
                default:
                    throw new IllegalStateException("Unexpected type: " + id);
            }
            return type;
        }

        @BackwardCompatibility
        public static AttributeType resolve(int id) {
            final AttributeType type;
            switch (id) {
                case 1:
                    type = NUMERIC;
                    break;
                case 2:
                    type = NOMINAL;
                    break;
                default:
                    throw new IllegalStateException("Unexpected type: " + id);
            }
            return type;
        }

    }

    @Immutable
    public static final class NumericAttribute extends Attribute {

        public NumericAttribute() {
            super(AttributeType.NUMERIC);
        }

        @Override
        public String toString() {
            return "NumericAttribute [type=" + type + "]";
        }

    }

    @Mutable
    public static final class NominalAttribute extends Attribute {

        private int size;

        public NominalAttribute() {
            super(AttributeType.NOMINAL);
            this.size = -1;
        }

        @Override
        public int getSize() {
            return size;
        }

        @Override
        public void setSize(int size) {
            this.size = size;
        }

        @Override
        public void writeTo(ObjectOutput out) throws IOException {
            super.writeTo(out);
            out.writeInt(size);
        }

        @Override
        public String toString() {
            return "NominalAttribute [size=" + size + ", type=" + type + "]";
        }

    }

    public static Attribute readFrom(ObjectInput in) throws IOException {
        final Attribute attr;

        byte typeId = in.readByte();
        final AttributeType type = AttributeType.resolve(typeId);
        switch (type) {
            case NUMERIC: {
                attr = new NumericAttribute();
                break;
            }
            case NOMINAL: {
                attr = new NominalAttribute();
                int size = in.readInt();
                attr.setSize(size);
                break;
            }
            default:
                throw new IllegalStateException("Unexpected type: " + type);
        }
        return attr;
    }

}