com.marklogic.mapreduce.DocumentURIWithSourceInfo Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2003-2019 MarkLogic Corporation

 *
 * 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 com.marklogic.mapreduce;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;

import org.apache.hadoop.io.Text;

/**
 * Document URI with source information. Use with
 * {@link DocumentInputFormat} and {@link ContentOutputFormat}.
 * 
 * @author jchen
 */

public class DocumentURIWithSourceInfo extends DocumentURI {

    private String srcId = "";
    private String subId = "";
    private int lineNumber = 0;
    private int colNumber = 0;
    private String skipReason = "";
    
    public DocumentURIWithSourceInfo() {};
    
    public DocumentURIWithSourceInfo(String uri, String src) {
        if (uri == null) {
            uri = "";
        } else {
            this.uri = uri;
        }    
        srcId = src;
    }
    
    public DocumentURIWithSourceInfo(String uri, String src, String sub) {
        if (uri == null) {
            uri = "";
        } else {
            this.uri = uri;
        } 
        srcId = src;
        subId = sub;
    }
    
    public DocumentURIWithSourceInfo(String uri, String src, String sub, 
            int line, int col) {
        if (uri == null) {
            uri = "";
        } else {
            this.uri = uri;
        } 
        srcId = src;
        subId = sub;
        lineNumber = line;
        colNumber = col;
    }
    
    public DocumentURIWithSourceInfo(DocumentURIWithSourceInfo uri) {
        this.uri = uri.uri;
        this.srcId = uri.srcId;
        this.subId = uri.subId;
        this.lineNumber = uri.lineNumber;
        this.colNumber = uri.colNumber;
        this.skipReason = uri.skipReason;
    }
    
    public boolean isSkip() {
        return uri.isEmpty();
    }
    
    @Override
    public void readFields(DataInput in) throws IOException {
        uri = Text.readString(in);
        srcId = Text.readString(in);
        subId = Text.readString(in);
        lineNumber = in.readInt();
        colNumber = in.readInt();
        skipReason = Text.readString(in);
    }

    @Override
    public void write(DataOutput out) throws IOException {
        Text.writeString(out, uri);
        Text.writeString(out, srcId);
        Text.writeString(out, subId);
        out.writeInt(lineNumber);
        out.writeInt(colNumber);
        Text.writeString(out, skipReason);
    }

    public String getSrcId() {
        return srcId;
    }

    public void setSrcId(String srcId) {
        this.srcId = srcId;
    }

    public String getSubId() {
        return subId;
    }

    public void setSubId(String subId) {
        this.subId = subId;
    }

    public int getLineNumber() {
        return lineNumber;
    }

    public void setLineNumber(int lineNumber) {
        this.lineNumber = lineNumber;
    }

    public int getColNumber() {
        return colNumber;
    }

    public void setColNumber(int colNumber) {
        this.colNumber = colNumber;
    }
    
    public String getSkipReason() {
        return skipReason;
    }

    public void setSkipReason(String reason) {
        this.skipReason = reason;
    }

    @Override
    public String toString() {
        StringBuilder buf = new StringBuilder();
        buf.append(uri.isEmpty() ? "()" : uri);       
        if (subId.length() > 0) {
            buf.append(" from ").append(subId);
        }
        if (srcId.length() > 0) {
            buf.append(" in ").append(srcId);
        }
        if (lineNumber > 0) {
            buf.append(" at line ").append(lineNumber);
        }
        if (colNumber > 0) {
            buf.append(":").append(colNumber);
        }
        if (!skipReason.isEmpty()) {
            buf.append(", reason: ");
            buf.append(skipReason);
        }
        return buf.toString();
    }
    
    @Override
    public Object clone() {
        return new DocumentURIWithSourceInfo(this);
    }
}